Pular para o conteúdo principal

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.

SecçãoO que encontra
OnboardingPrimeiro dia no projeto
ArquiteturaMódulos, dual BD, JWT, WebSocket
ADRsDecisões e o porquê
APIsContrato por domínio
Catálogo completoTodos os endpoints HTTP + WebSocket
Modelo de dadosERD, tabelas, SQL
SetupInstalação detalhada
DeployDocker, CI, rollback
RunbooksQuando produção falha
TestesJest, e2e, Stryker, Sonar
SequênciasDiagramas Mermaid
Guias frontendIntegração, login, cadastro
OperaçãoEnv no container, Wiki.js

Recursos rápidos​

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.