Bem-vindo à documentação técnica completa do projeto Varion. Esta pasta contém guias detalhados para configuração, desenvolvimento, deploy e manutenção do sistema.
- ARCHITECTURE.md - Visão geral da arquitetura do sistema, padrões e componentes
- SETUP.md - Guia completo de instalação e configuração inicial
- ENVIRONMENT.md - Documentação detalhada das variáveis de ambiente
- DEVELOPMENT.md - Ambiente de desenvolvimento, workflow e troubleshooting
- DOCKER.md - Configuração Docker, containers e desenvolvimento local
- DEPLOYMENT.md - Guias de deploy (Docker, Kubernetes, Cloud, Serverless)
- TESTING.md - Estratégias de teste, configuração e automação
- SECURITY.md - Práticas de segurança, autenticação e compliance
- CHANGELOG.md - Histórico de mudanças na documentação
- PROXIMOS-OBJETIVOS.md - Roadmap e próximos objetivos do projeto
- Primeira vez no projeto? Comece com SETUP.md
- Desenvolvendo? Consulte DEVELOPMENT.md
- Fazendo deploy? Veja DEPLOYMENT.md
- Docker? Use DOCKER.md
| Documento | Status | Última Atualização |
|---|---|---|
| ARCHITECTURE.md | ✅ Completo | Jun 2025 |
| SETUP.md | ✅ Completo | Jun 2025 |
| ENVIRONMENT.md | ✅ Completo | Jun 2025 |
| DEVELOPMENT.md | ✅ Completo | Jun 2025 |
| DOCKER.md | ✅ Completo | Jun 2025 |
| DEPLOYMENT.md | ✅ Completo | Jun 2025 |
| TESTING.md | ✅ Completo | Jun 2025 |
| SECURITY.md | ✅ Completo | Jun 2025 |
| PROXIMOS-OBJETIVOS.md | ✅ Completo | Jun 2025 |
- README Principal - Visão geral do projeto
- Backend Docs - Documentação específica da API
- Frontend Docs - Documentação específica do frontend
Para contribuir com a documentação:
- Mantenha a linguagem clara e objetiva
- Use exemplos práticos sempre que possível
- Atualize o índice quando adicionar novos documentos
- Teste as instruções antes de documentar
- Use badges e ícones para melhor visualização
Se você encontrar problemas ou tiver dúvidas sobre a documentação:
- Verifique primeiro os guias de troubleshooting em DEVELOPMENT.md
- Consulte a documentação da API em ../backend/docs/
- Abra uma issue no repositório do projeto
Documentação mantida com ❤️ pela equipe Varion