Documentação AMPLIA
Índice da pasta docs/. O cartão de visita do repositório (README, licença,
contribuição, segurança, changelog) fica na raiz.
Última revisão: 16/09/2026.
Comece por aqui
| Documento | Quando usar |
|---|---|
| ../README.md | O que é, como subir, comandos |
| setup.md | Instalação completa (PHP, Docker, migrations, env) |
| onboarding.md | Primeiro dia de um dev novo |
| arquitetura.md | C4, camadas, integrações, decisões vigentes |
| api.md | Contrato HTTP, auth, CSRF, envelope JSON |
| api/endpoints.md | Catálogo de todos os endpoints |
| api/openapi.yaml | OpenAPI 3.0 gerado a partir de backend/api |
Operação
| Documento | Quando usar |
|---|---|
| deploy.md | Ambientes, pipeline, rollback |
| runbooks.md | Produção quebrou: o que fazer |
| testes.md | Estratégia, cobertura esperada, checklists |
| modelo-dados.md | ERD, tabelas, dicionário |
| SECURITY.md | Como reportar vulnerabilidade |
Produto e autorização
| Documento | Conteúdo |
|---|---|
| mapa-dominio-gevtech.md | Atores, bounded contexts, eventos |
| rbac-tenant-design.md | RBAC em dois níveis (WL + usuário) |
| permissoes-matriz-endpoints.md | Matriz endpoint → flag |
| permissoes-guia-nova-flag.md | Checklist para criar permissão |
| modulos-tarefas.md | Spec completa do módulo Tarefas |
| modal_trocar_representante.md | Troca de representante |
| ajustes-estabelecimentos-chat-20260821-20260824.md | Pipeline KYC/docs do EC |
Engenharia (histórico e plano)
| Documento | Conteúdo |
|---|---|
| manual-tecnico.md | Manual técnico consolidado (stack, módulos, lacunas) |
| adr/README.md | Architecture Decision Records |
| plano-migracao-psr4.md | Plano de autoload PSR-4 |
| front-dashboard-refactor-map.md | Reorganização do frontend |
| schema-usage-audit.md | Auditoria de uso de tabelas |
| nonessential-files-audit.md | Candidatos a remoção |
| security-hardening-20260807.md | Hardening 2026-08-07 |
| design-system/tailwind-padroes.md | Padrões visuais Tailwind |
Integração PayUp (guias do provedor): backend/src/integrations/payup/.