Pular para o conteúdo principal

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: 19/09/2026.

Como esta pasta está organizada​

PastaO que entraPode apagar?
operacao/Setup, onboarding, deploy, runbooks, testesNão — guias vivos
arquitetura/C4, ADRs, modelo de dados, fluxos de módulo, integraçõesNão — fonte da verdade
api/Contrato HTTP, catálogo de endpoints, OpenAPINão — contrato vivo
seguranca/RBAC, matriz de flags, hardeningNão — autorização vigente
front/Design system, mapa do dashboard, fluxos de UINão — padrão visual/UX
extra/Demanda pontual, dump de chat, auditoria datadaSim — ver extra/README.md

Documento novo: coloque na pasta do tema. Se for só o recorte de um chat ou uma auditoria de um dia, vá para extra/ — assim fica óbvio o que pode sair.

Comece por aqui​

DocumentoQuando usar
../README.mdO que é, como subir, comandos
operacao/setup.mdInstalação completa (PHP, Docker, migrations, env)
operacao/onboarding.mdPrimeiro dia de um dev novo
arquitetura/arquitetura.mdC4, camadas, integrações, decisões vigentes
api/README.mdContrato HTTP, auth, CSRF, envelope JSON
api/endpoints.mdCatálogo de todos os endpoints
api/openapi.yamlOpenAPI 3.0 gerado a partir de backend/api

Operação​

DocumentoQuando usar
operacao/deploy.mdAmbientes, pipeline, rollback
operacao/runbooks.mdProdução quebrou: o que fazer
operacao/testes.mdEstratégia, cobertura esperada, checklists
../SECURITY.mdComo reportar vulnerabilidade

Arquitetura e domínio​

DocumentoConteúdo
arquitetura/mapa-dominio-gevtech.mdAtores, bounded contexts, eventos
arquitetura/modelo-dados.mdERD, tabelas, dicionário
arquitetura/manual-tecnico.mdManual técnico consolidado
arquitetura/adr/README.mdArchitecture Decision Records
arquitetura/modulos-tarefas.mdSpec completa do módulo Tarefas
arquitetura/integracao-google-agenda.mdOAuth Google Agenda (visitas)
arquitetura/plano-migracao-psr4.mdPlano de autoload PSR-4

Segurança e autorização​

DocumentoConteúdo
seguranca/rbac-tenant-design.mdRBAC em dois níveis (WL + usuário)
seguranca/permissoes-matriz-endpoints.mdMatriz endpoint → flag
seguranca/permissoes-guia-nova-flag.mdChecklist para criar permissão
seguranca/security-hardening-20260807.mdHardening 2026-08-07 (snapshot)

Front​

DocumentoConteúdo
front/design-system/tailwind-padroes.mdPadrões visuais Tailwind
front/front-dashboard-refactor-map.mdReorganização do frontend
front/modal_trocar_representante.mdFluxo de troca de representante

Integração PayUp (guias do provedor): backend/src/integrations/payup/.