Documentação CentralCRM_back
Backend NestJS do CentralCRM / Arkus: API REST versionada (/api/v1), autenticação JWT, diretório multi-tenant, dados operacionais, presença em tempo real (Socket.IO) e white labels.
!!! info "GEVTECH" Site gerado com MkDocs Material. Cartão de visita no GitHub: README.md na raiz do repositório.
Navegar
| Secção | O que encontra |
|---|---|
| Onboarding | Primeiro dia no projeto |
| Arquitetura | Módulos, dual BD, JWT, WebSocket |
| ADRs | Decisões e o porquê |
| APIs | Contrato por domínio |
| Catálogo completo | Todos os endpoints HTTP + WebSocket |
| Modelo de dados | ERD, tabelas, SQL |
| Setup | Instalação detalhada |
| Deploy | Docker, CI, rollback |
| Runbooks | Quando produção falha |
| Testes | Jest, e2e, Stryker, Sonar |
| Sequências | Diagramas Mermaid |
| Guias frontend | Integração, login, cadastro |
| Operação | Env no container, Wiki.js |
Recursos rápidos
- Swagger (local):
http://localhost:3000/api/docs - Postman: collection
- SQL: pasta
sql/ - Contribuir: CONTRIBUTING.md
- Segurança: SECURITY.md
Setup local da API
cp .env.example .env
npm install
npm run start:dev
A API escuta em http://localhost:3000. Detalhe: setup/instalacao.md.