Guides and reference
Documentation
Build it, ship it, run it.
Guides and reference for Nelcota: local quickstart, REST API, auth, storage, webhooks, SDKs, deploy, backup and the CLI.
/
These guides follow the main branch. The latest published release is v0.5.0; features the guides mark as unreleased need a newer version.
Start here
All guides
Start
5 guides- Local quickstart Install, write a migration and make an authenticated request.
- JS SDK quickstart First steps with @nelcota/client (written in Portuguese).
- Notes example Private notes and files, end to end, plus a restart check.
- Troubleshooting Empty results, 401/403, types and limits.
- Glossary Terms used across the guides.
Build an application
10 guides- REST API Queries, relations, writes, RPC, OpenAPI and errors.
- Authentication Users, sessions, email links and OAuth in the auth schema.
- JWT and roles Token format and the PostgreSQL roles behind each request.
- Storage Disk or S3, bucket policies, signed URLs and limits.
- Webhooks Durable events, signatures, retries and delivery history.
- TypeScript SDK The @nelcota/client package: REST, auth and storage.
- Rust SDK The nelcota-client crate for Tokio applications.
- Rust SDK quickstart First steps with nelcota-client (written in Portuguese).
- Examples Schemas and runnable consumers.
- Auth in Rust apps Use Nelcota authentication inside another Rust application.
Operate
8 guides- Deploy A VPS with Docker or systemd, HTTPS and isolated projects.
- Backup and restore Paired snapshots, offsite copies and point-in-time recovery.
- Admin panel What the panel shows and what it is allowed to do.
- Panel updates Controlled updates and the acceptance they need on the VPS.
- Project management Create, back up, restore and remove projects on a host.
- Security model Trust boundaries and what stays with the deployer.
- Release handoff Upgrading after the Notes acceptance.
- Leaving Nelcota Export schema, users and files to another backend.