4.1 KiB
4.1 KiB
📚 Documentação - Aggios
Documentação centralizada do projeto Aggios.
📂 Estrutura
1. docs/
├── README.md ← Você está aqui
├── design-system.md # Design System
├── info-cadastro-agencia.md # Informações - Cadastro de Agência
├── instrucoes-ia.md # Instruções para IA
├── plano.md # Plano do Projeto
├── projeto.md # Visão Geral do Projeto
│
└── backend-deployment/ # Documentação Backend + Traefik
├── 00_START_HERE.txt # 👈 COMECE AQUI!
├── INDEX.md # Índice completo
├── QUICKSTART.md # 5 minutos para começar
├── ARCHITECTURE.md # Design da arquitetura
├── API_REFERENCE.md # Todos os endpoints
├── DEPLOYMENT.md # Deploy e scaling
├── SECURITY.md # Segurança e checklist
├── TESTING_GUIDE.md # Como testar
├── IMPLEMENTATION_SUMMARY.md # Resumo implementação
└── README_IMPLEMENTATION.md # Status do projeto
🚀 Começar Rápido
1️⃣ Backend + Traefik (Novo)
👉 Leia: backend-deployment/00_START_HERE.txt
Documentação completa do backend Go, Traefik, PostgreSQL, Redis e MinIO.
2️⃣ Projeto & Visão
👉 Consulte:
- projeto.md - Visão geral do projeto
- plano.md - Plano detalhado
3️⃣ Design & UX
👉 Consulte:
- design-system.md - Design System
4️⃣ Informações Específicas
👉 Consulte:
- info-cadastro-agencia.md - Cadastro de agências
- instrucoes-ia.md - Instruções para IA
📖 Documentação Backend em Detalhes
Pasta: backend-deployment/
| Documento | Descrição |
|---|---|
| 00_START_HERE.txt | 👈 COMECE AQUI! Visão geral e primeiros passos |
| INDEX.md | Índice completo e navegação |
| QUICKSTART.md | Setup em 5 minutos |
| ARCHITECTURE.md | Design da arquitetura (Go + Traefik + Multi-tenant) |
| API_REFERENCE.md | Todos os endpoints com exemplos |
| DEPLOYMENT.md | Guia de deploy e scaling |
| SECURITY.md | Segurança, checklist produção e boas práticas |
| TESTING_GUIDE.md | Como testar toda a stack |
| IMPLEMENTATION_SUMMARY.md | Resumo do que foi implementado |
| README_IMPLEMENTATION.md | Status do projeto e próximos passos |
🎯 Por Experiência
👶 Iniciante
- Leia projeto.md
- Consulte backend-deployment/QUICKSTART.md
- Execute
docker-compose up -d
👨💻 Desenvolvedor
- Estude backend-deployment/ARCHITECTURE.md
- Consulte backend-deployment/API_REFERENCE.md
- Comece a codificar em
backend/
🏗️ DevOps/Infrastructure
- Leia backend-deployment/DEPLOYMENT.md
- Revise backend-deployment/SECURITY.md
- Siga backend-deployment/TESTING_GUIDE.md
🎨 Designer/UX
- Consulte design-system.md
- Revise plano.md
📞 Navegação Rápida
Backend:
- Setup → QUICKSTART.md
- Arquitetura → ARCHITECTURE.md
- API → API_REFERENCE.md
- Deploy → DEPLOYMENT.md
- Segurança → SECURITY.md
- Testes → TESTING_GUIDE.md
Projeto:
- Visão geral → projeto.md
- Plano → plano.md
- Design → design-system.md
- Cadastros → info-cadastro-agencia.md
Status: ✅ Documentação Centralizada
Última atualização: Dezembro 5, 2025
Versão: 1.0.0