Skip to content

Commit abb57e7

Browse files
CopilotBulletdev
andcommitted
Create comprehensive architecture documentation with Mermaid diagrams
Co-authored-by: Bulletdev <[email protected]>
1 parent 6b6b07a commit abb57e7

File tree

6 files changed

+689
-0
lines changed

6 files changed

+689
-0
lines changed

docs/README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Documentação - Go Cart API
2+
3+
Bem-vindo à documentação técnica do projeto Go Cart API. Este diretório contém toda a documentação arquitetural e técnica do sistema.
4+
5+
## 📁 Arquivos de Documentação
6+
7+
### 🏗️ [architecture.md](./architecture.md)
8+
Documentação completa da arquitetura do sistema, incluindo:
9+
10+
- **Diagrama de Arquitetura Geral**: Visão macro do sistema com todas as camadas
11+
- **Fluxo de Autenticação**: Sequência detalhada dos processos de login/registro
12+
- **Modelo de Dados (ERD)**: Estrutura do banco de dados com relacionamentos
13+
- **Fluxo de Requests**: Como as requisições são processadas
14+
- **Estrutura de Pastas**: Organização do código e responsabilidades
15+
- **Tecnologias Utilizadas**: Stack tecnológico completo
16+
- **Padrões Arquiteturais**: Design patterns implementados
17+
18+
## 🎯 Como Visualizar os Diagramas
19+
20+
Os diagramas estão criados em formato **Mermaid**, que pode ser visualizado em:
21+
22+
### GitHub
23+
Os diagramas são renderizados automaticamente quando você visualiza os arquivos `.md` diretamente no GitHub.
24+
25+
### Editores Locais
26+
- **VS Code**: Instale a extensão "Mermaid Preview"
27+
- **IntelliJ/GoLand**: Suporte nativo para Mermaid
28+
- **Online**: [Mermaid Live Editor](https://mermaid.live/)
29+
30+
### Documentação Online
31+
- GitBook, Notion, ou qualquer plataforma que suporte Mermaid
32+
33+
## 🧩 Visão Geral da Arquitetura
34+
35+
Este projeto segue os princípios de **Clean Architecture** com as seguintes características:
36+
37+
- **Separação de Responsabilidades**: Cada camada tem função específica
38+
- **Inversão de Dependências**: Interfaces bem definidas entre camadas
39+
- **Testabilidade**: Estrutura preparada para testes unitários e integração
40+
- **Escalabilidade**: Arquitetura que facilita crescimento e manutenção
41+
42+
## 🚀 Stack Tecnológico Principal
43+
44+
- **Backend**: Go 1.23+ com Gorilla Mux
45+
- **Database**: PostgreSQL via Supabase
46+
- **Autenticação**: JWT + bcrypt
47+
- **Deploy**: Render/Heroku
48+
- **Testes**: Go testing + testify
49+
50+
## 📚 Para Desenvolvedores
51+
52+
Se você é novo no projeto, recomendamos a leitura na seguinte ordem:
53+
54+
1. **README principal** do projeto para setup inicial
55+
2. **[architecture.md](./architecture.md)** para entender a estrutura
56+
3. **Código fonte** começando por `cmd/main.go`
57+
4. **Testes** em `internal/handlers/*_test.go`
58+
59+
## 🔄 Manutenção da Documentação
60+
61+
Esta documentação deve ser atualizada sempre que:
62+
- Novos componentes forem adicionados
63+
- A arquitetura for modificada
64+
- Novas dependências forem incluídas
65+
- Padrões de desenvolvimento mudarem
66+
67+
## 📞 Suporte
68+
69+
Para dúvidas sobre a arquitetura ou documentação:
70+
- Abra uma issue no repositório
71+
- Entre em contato com a equipe de desenvolvimento

0 commit comments

Comments
 (0)