Guias e referência
Documentação
Construa, publique, opere.
Guias e referência do Nelcota: quickstart local, API REST, autenticação, arquivos, webhooks, SDKs, deploy, backup e a CLI.
/
Estes guias acompanham a branch main. A última versão publicada é a v0.5.0; recursos que os guias marcam como não publicados exigem uma versão mais nova.
Comece por aqui
Todos os guias
Começar
5 guias- Quickstart local Instale, escreva uma migration e faça uma requisição autenticada.
- Começar com o SDK JS Primeiros passos com o @nelcota/client.
- Exemplo Notes Notas e arquivos privados de ponta a ponta, com teste de reinício.
- Resolver problemas Resultados vazios, 401/403, tipos e limites.
- Glossário Termos usados nos guias.
Construir um aplicativo
10 guias- API REST Consultas, relações, escritas, RPC, OpenAPI e erros.
- Autenticação Usuários, sessões, links por e-mail e OAuth no schema auth.
- JWT e papéis Formato do token e os papéis do PostgreSQL em cada requisição.
- Armazenamento Disco ou S3, políticas de bucket, URLs assinadas e limites.
- Webhooks Eventos duráveis, assinaturas, novas tentativas e histórico.
- SDK TypeScript O pacote @nelcota/client: REST, auth e arquivos.
- SDK Rust O crate nelcota-client para aplicações Tokio.
- Começar com Rust Primeiros passos com o nelcota-client.
- Exemplos Schemas e consumidores prontos para rodar.
- Auth em apps Rust Use a autenticação do Nelcota em outra aplicação Rust.
Operar
8 guias- Deploy Uma VPS com Docker ou systemd, HTTPS e projetos isolados.
- Backup e restauração Snapshots pareados, cópias externas e recuperação no tempo.
- Painel admin O que o painel mostra e o que ele pode fazer.
- Atualizar pelo painel Atualizações controladas e o aceite que exigem na VPS.
- Gestão de projetos Criar, copiar, restaurar e remover projetos em um host.
- Modelo de segurança Limites de confiança e o que fica com quem implanta.
- Entrega de versão Atualização depois do aceite do Notes.
- Sair do Nelcota Exporte schema, usuários e arquivos para outro backend.