core/docs/BACKEND.md
2025-12-27 13:04:36 -03:00

43 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Backend de leitura do Appwrite
Este backend expõe uma API HTTP simples para consultar os documentos das coleções
criadas pelo `setup-appwrite.js` no Appwrite.
## ✨ O que ele faz
- Conecta no Appwrite usando as variáveis `APPWRITE_*` do `.env`.
- Exponde endpoints REST para ler dados das collections:
- `/servers`
- `/github-repos`
- `/audit-logs` (ordenado por `timestamp` desc)
- `/cloud-accounts`
- Suporta paginação via query params:
- `limit` (1100)
- `offset` (>= 0)
## ▶️ Como rodar
1. Garanta que o `.env` tem as variáveis necessárias.
2. Instale as dependências do projeto (`npm install`).
3. Inicie o backend:
```bash
npm run dev:backend
```
O servidor inicia em `http://localhost:4000`.
## ⚙️ Variáveis necessárias
- `APPWRITE_ENDPOINT`
- `APPWRITE_PROJECT_ID`
- `APPWRITE_API_KEY`
- `APPWRITE_DATABASE_ID` (ou `VITE_APPWRITE_DATABASE_ID`)
- `APPWRITE_COLLECTION_*_ID` (ou `VITE_APPWRITE_COLLECTION_*_ID`)
## 🔍 Exemplo de requisições
```bash
curl http://localhost:4000/servers?limit=10
curl http://localhost:4000/audit-logs?limit=20&offset=0
```