Documentação — CentralCRM_back
Índice da pasta docs/. O cartão de visita do repositório está na raiz: README.md.
Entrada
| Documento | Descrição |
|---|---|
| index.md | Home do site MkDocs |
| onboarding.md | Novo developer |
| arquitetura/ | Visão técnica |
| adr/ | Architecture Decision Records |
| apis/catalogo-completo.md | Todos os endpoints |
| modelo-dados/ | Schema / ERD |
| setup/instalacao.md | Instalação detalhada |
| deploy/ | CI/CD e rollback |
| runbooks/ | Operação em falha |
| testes/estrategia.md | Estratégia de testes |
Arquitetura e operação (legado + canónico)
| Documento | Descrição |
|---|---|
| ARQUITETURA.md | Alias da visão completa |
| arquitetura/visao-completa.md | Canónico |
| ENTENDIMENTO.md | Presença end-to-end |
| ENV_CONTAINER.md | Variáveis no Docker / Swarm |
| operacao/docker-db-debug.md | Debug PostgreSQL no container |
Integração frontend
| Documento | Descrição |
|---|---|
| guias/frontend-apis.md | Auth + companies, erros, Bearer |
| guias/migracao-auth-users.md | Migração APIs de utilizador |
| guias/login.md | Login |
| guias/register.md | Registo |
| guias/post-company.md | POST empresa |
| guias/cadastro-company.md | Cadastro completo |
Schema SQL
| Ficheiro | Descrição |
|---|---|
| sql/company-table.sql | Tabela company |
| sql/company-directory-tables.sql | Diretório |
| sql/todastabelas.sql | Referência ampla |
| sql/auth_user_table.sql | public."user" |
| sql/migrations/ | Migrations numeradas |
API interativa
| Recurso | URL |
|---|---|
| Swagger UI | http://localhost:3000/api/docs |
| OpenAPI JSON | GET /api/docs-json |
| OpenAPI YAML | GET /api/docs-yaml |
| Catálogo Markdown | apis/catalogo-completo.md |
Postman
| Ficheiro | Descrição |
|---|---|
| postman/CentralCRM_API.postman_collection.json | Collection |
| postman/CentralCRM_local.postman_environment.json | baseUrl, accessToken |
Fluxo: Auth → Login (preenche accessToken) e depois as restantes pastas.