Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
<PackageVersion Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.9" />
<PackageVersion Include="EFCore.NamingConventions" Version="9.0.0" />
<PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="9.0.4" />
<PackageVersion Include="Npgsql.EntityFrameworkCore.PostgreSQL.NetTopologySuite" Version="9.0.4" />

<!-- Data Access -->
<PackageVersion Include="Dapper" Version="2.1.66" />
Expand Down
368 changes: 0 additions & 368 deletions docs/PLAN.md

This file was deleted.

203 changes: 51 additions & 152 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,168 +12,68 @@ Se você é novo no projeto, comece por aqui:

## 📋 Documentação Principal

### **🛠️ Desenvolvimento**
| Documento | Descrição |
|-----------|-----------|
| **[🏗️ Arquitetura](./architecture.md)** | Clean Architecture, DDD, CQRS e padrões |
| **[🔐 Autenticação e Autorização](./authentication_and_authorization.md)** | Keycloak, JWT e sistema de permissões type-safe |
| **[🔄 CI/CD & Security](./ci_cd.md)** | Pipelines, deploy, automação e security scanning |
| **[⚙️ Configuração](./configuration.md)** | Gestão de constantes e configuração por ambiente |
| **[🛠️ Guia de Desenvolvimento](./development.md)** | Setup completo, convenções, workflows, debugging e testes |
| **[🚀 Infraestrutura](./infrastructure.md)** | Docker, Aspire, Azure e configuração de ambientes |
| **[🗺️ Roadmap do Projeto](./roadmap.md)** | Funcionalidades futuras e planejamento |
| **[🔩 Débito Técnico](./technical_debt.md)** | Itens de débito técnico e melhorias planejadas |

| Documento | Descrição | Para quem |
|-----------|-----------|-----------|
| **[🛠️ Guia de Desenvolvimento](./development.md)** | Setup completo, convenções, workflows, debugging e testes | Desenvolvedores |
| **[🏗️ Arquitetura](./architecture.md)** | Clean Architecture, DDD, CQRS e padrões | Arquitetos e desenvolvedores |
| **[📦 Adicionando Novos Módulos](./adding-new-modules.md)** | Como adicionar módulos com testes e cobertura | Desenvolvedores |

### **🔐 Segurança e Autenticação**

| Documento | Descrição | Para quem |
|-----------|-----------|-----------|
| **[� Autenticação Completa](./authentication.md)** | Keycloak, JWT e sistema de autorização | Desenvolvedores |
| **[🛡️ Implementação de Autorização](./authorization_implementation.md)** | Sistema type-safe de permissões | Desenvolvedores |
| **[🔑 Permissões Type-Safe](./type_safe_permissions.md)** | Detalhes do sistema baseado em EPermission | Desenvolvedores |
| **[🖥️ Permissões Server-Side](./server_side_permissions.md)** | Resolução de permissões no servidor | Desenvolvedores backend |
| **[🔑 Integração Keycloak](./keycloak_integration.md)** | Configuração e integração detalhada | Administradores |

### **📱 Módulos de Domínio**

| Documento | Descrição | Para quem |
|-----------|-----------|-----------|
| **[👥 Módulo Users](./modules/users.md)** | Gestão de usuários, autenticação e perfis | Desenvolvedores |
| **[🔧 Módulo Providers](./modules/providers.md)** | Prestadores de serviços, verificação e documentos | Desenvolvedores |
| **[📋 Módulo Services](./modules/services.md)** | Catálogo de serviços (planejado) | Desenvolvedores |
| **[📅 Módulo Bookings](./modules/bookings.md)** | Sistema de agendamentos (planejado) | Desenvolvedores |
| **[🗺️ Roadmap do Projeto](./ROADMAP.md)** | Funcionalidades futuras e planejamento | Todos |
## 📁 Documentação Especializada

### **🚀 Infraestrutura e Deploy**
### **🗄️ Database**

| Documento | Descrição | Para quem |
|-----------|-----------|-----------|
| **[🚀 Infraestrutura](./infrastructure.md)** | Docker, Aspire, Azure e configuração de ambientes | DevOps |
| **[🔄 CI/CD & Security](./ci_cd.md)** | Pipelines, deploy, automação e security scanning | DevOps |
| **[🌍 Ambientes de Deploy](./deployment_environments.md)** | Configuração de ambientes | DevOps |
| Documento | Descrição |
|-----------|-----------|
| **[🗄️ Limites do Banco de Dados](./database/database_boundaries.md)** | Estratégia de schemas modulares |
| **[🏭 DbContext Factory](./database/db_context_factory.md)** | Factory pattern para Entity Framework |
| **[🗃️ Organização de Scripts](./database/scripts_organization.md)** | Como organizar e criar scripts de banco para novos módulos |

### **⚙️ Configuração e Constantes**
### **📝 Logging**

| Documento | Descrição | Para quem |
|-----------|-----------|--------|
| **[📋 Templates de Configuração](./configuration-templates/)** | Templates para todos os ambientes | Desenvolvedores |
| **[🔧 Sistema de Constantes](./constants_system.md)** | Gestão centralizada de constantes | Desenvolvedores |
| Documento | Descrição |
|-----------|-----------|
| **[🆔 Correlation ID](./logging/CORRELATION_ID.md)** | Melhores práticas para implementação e uso de Correlation IDs |
| **[⏱️ Desempenho](./logging/PERFORMANCE.md)** | Estratégias e ferramentas de monitoramento de desempenho |
| **[📊 Seq Setup](./logging/SEQ_SETUP.md)** | Configuração do Seq para logging estruturado |

### **📚 Guias e Relatórios**

| Documento | Descrição | Para quem |
|-----------|-----------|--------|
| **[📝 EditorConfig Implementation Guide](./guides/editorconfig-implementation-guide.md)** | Guia de implementação do EditorConfig | Desenvolvedores |
| **[🔒 Security Improvements Report](./reports/security-improvements-report.md)** | Relatório de melhorias de segurança | Arquitetos, DevOps |
| **[📋 PLAN.md](./PLAN.md)** | Plano geral do projeto | Todos |
| **[🚀 WARP.md](./WARP.md)** | Documentação WARP | Todos |
### **💬 Messaging**

## 📁 Documentação Especializada
| Documento | Descrição |
|-----------|-----------|
| **[💀 Dead Letter Queue](./messaging/dead_letter_queue.md)** | Estratégia completa de DLQ com operações |
| **[🚌 Estratégia de Message Bus](./messaging/message_bus_strategy.md)** | Estratégia de messaging por ambiente |
| **[🧪 Mocks de Messaging](./messaging/messaging_mocks.md)** | Mocks para testes de messaging |

### **💬 Messaging**
### **📱 Módulos de Domínio**

| Documento | Descrição | Nível |
|-----------|-----------|-------|
| **[💀 Dead Letter Queue Strategy](./messaging/dead_letter_queue_strategy.md)** | Estratégia completa de DLQ com operações | Avançado |
| **[📊 Resumo da Implementação DLQ](./messaging/dead_letter_queue_implementation_summary.md)** | Resumo da implementação | Intermediário |
| **[� Message Bus Strategy](./messaging/message_bus_strategy.md)** | Estratégia de messaging por ambiente | Avançado |
| **[🧪 Messaging Mocks](./messaging/messaging_mocks.md)** | Mocks para testes de messaging | Avançado |
| Documento | Descrição |
|-----------|-----------|
| **[📅 Módulo Bookings](./modules/bookings.md)** | Sistema de agendamentos (planejado) |
| **[📄 Módulo Documents](./modules/documents.md)** | Gerenciamento de documentos |
| **[🔧 Módulo Providers](./modules/providers.md)** | Prestadores de serviços, verificação e documentos |
| **[🔍 Módulo Search](./modules/search.md)** | Busca geoespacial de prestadores com PostGIS |
| **[📋 Módulo Services](./modules/services.md)** | Catálogo de serviços (planejado) |
| **[👥 Módulo Users](./modules/users.md)** | Gestão de usuários, autenticação e perfis |

### **🗄️ Database**
### **🧪 Testes**

| Documento | Descrição | Nível |
|-----------|-----------|-------|
| **[🔄 Database Migration](./database/database_migration.md)** | Estratégia de migrations | Intermediário |
| **[🏭 DbContext Factory](./database/db_context_factory.md)** | Factory pattern para Entity Framework | Intermediário |
| **[🗄️ Database Boundaries](./database/database_boundaries.md)** | Estratégia de schemas modulares | Avançado |
| **[📊 PostgreSQL Setup](./database/postgresql_setup.md)** | Configuração e otimização | Intermediário |
| **[🔒 Database Security](./database/database_security.md)** | Segurança e acesso | Avançado |
| Documento | Descrição |
|-----------|-----------|
| **[📊 Guia de Cobertura de Código](./testing/code_coverage_guide.md)** | Como visualizar e interpretar a cobertura de código |
| **[⚙️ Testes de Integração](./testing/integration_tests.md)** | Guia para escrever e manter testes de integração |
| **[🔒 Exemplos de Testes de Autenticação](./testing/test_auth_examples.md)** | Exemplos práticos do TestAuthenticationHandler |

### **📝 Logging**
### **📚 Guias e Relatórios**

| Documento | Descrição | Nível |
|-----------|-----------|-------|
| **[� Logging Strategy](./logging/logging_strategy.md)** | Estratégia de logs estruturados | Intermediário |
| **[📊 Seq Setup](./logging/seq_setup.md)** | Configuração do Seq | Intermediário |
| **[🔍 Observability](./logging/observability.md)** | Monitoramento e métricas | Avançado |
| **[🐛 Troubleshooting](./logging/troubleshooting.md)** | Guia de resolução de problemas | Intermediário |

## 🎯 Guias por Cenário

### **🆕 Novo Desenvolvedor**
1. 📖 Leia o [README principal](../README.md) para entender o projeto
2. 🛠️ Siga o [Guia de Desenvolvimento](./development.md) para setup completo
3. 🏗️ Estude a [Arquitetura](./architecture.md) para entender os padrões
4. 🔐 Configure [Autenticação](./authentication.md) para desenvolvimento
5. 🧪 Aprenda sobre [Testes](./development.md#-diretrizes-de-testes)
6. 🚀 Configure [Infraestrutura](./infrastructure.md) local

### **🏗️ Arquiteto de Software**
1. 🏗️ Analise a [Arquitetura](./architecture.md) completa
2. 📐 Revise os padrões DDD e CQRS
3. 🗄️ Entenda a [estratégia de dados](./database/database_boundaries.md)
4. 💬 Avalie as [estratégias de messaging](./messaging/message_bus_strategy.md)
5. 🔐 Revise o [sistema de permissões](./type_safe_permissions.md)

### **🚀 DevOps Engineer**
1. 🚀 Configure a [Infraestrutura](./infrastructure.md)
2. 🔄 Implemente os [pipelines CI/CD](./ci_cd.md)
3. 🌍 Gerencie [ambientes](./deployment_environments.md)
4. 📊 Configure [monitoramento](./logging/observability.md)
5. 🔒 Implemente [security scanning](./ci_cd.md#-security-scanning-fixes)

### **🧪 QA Engineer**
1. 🧪 Entenda as [estratégias de teste](./development.md#-diretrizes-de-testes)
2. 🔐 Configure [autenticação de testes](./development.md#3-test-authentication-handler)
3. 🚀 Use [ambientes de teste](./infrastructure.md)
4. 🧪 Implemente [mocks de messaging](./messaging/messaging_mocks.md)

## 📈 Status da Documentação

### ✅ **Completo e Atualizado (Novembro 2025)**
- ✅ Guia de Desenvolvimento com Testes Integrados
- ✅ Sistema Completo de Autenticação e Autorização Type-Safe
- ✅ Arquitetura Clean Architecture + DDD + CQRS
- ✅ Infraestrutura Docker + Aspire + Azure
- ✅ CI/CD com Security Scanning Integrado
- ✅ Dead Letter Queue Strategy Operacional
- ✅ Database Boundaries e Migration Strategy
- ✅ Logging Estruturado e Observabilidade
- ✅ Configuration Templates por Ambiente
- ✅ Módulo Users - Gestão completa de usuários
- ✅ Módulo Providers - Prestadores de serviços implementado

### 🔄 **Em Evolução**
- 🔄 Documentação de APIs (com crescimento do projeto)
- 🔄 Guias de usuário final (futuro)
- 🔄 Módulo Services (planejado)
- 🔄 Módulo Bookings (planejado)

## 🧹 Reorganização Recente

**Outubro 2025**: Documentação completamente reorganizada para eliminar redundância:

### ✅ **Consolidações Realizadas**
- 📁 **Removidas 7 pastas** redundantes: `examples/`, `operations/`, `authentication/`, `technical/`, `testing/`, `deployment/`
- 📄 **Consolidados 15+ arquivos** duplicados
- 🔗 **Atualizados 25+ links** quebrados
- 📚 **Integradas** estratégias de testes ao `development.md`
- 🔐 **Unificadas** documentações de segurança e CI/CD
- 💀 **Consolidadas** múltiplas versões de Dead Letter Queue docs

### 🏗️ **Nova Estrutura**
```
docs/
├── 📄 Arquivos principais (14 documentos)
├── 📁 configuration-templates/ (7 templates)
├── 📁 database/ (5 documentos)
├── 📁 logging/ (4 documentos)
├── 📁 messaging/ (4 documentos)
├── 📁 guides/ (guias de implementação)
│ └── editorconfig-implementation-guide.md
├── 📁 reports/ (relatórios de análise)
│ └── security-improvements-report.md
└── 📁 modules/ (documentação de módulos)
├── users.md
├── providers.md
└── documents.md
```
| Documento | Descrição |
|-----------|-----------|
| **[📝 Guia de Implementação do EditorConfig](./guides/editorconfig_implementation_guide.md)** | Guia de implementação do EditorConfig |
| **[🔒 Relatório de Melhorias de Segurança](./reports/security_improvements_report.md)** | Relatório de melhorias de segurança |

## 🤝 Como Contribuir

Expand Down Expand Up @@ -219,7 +119,7 @@ docs/
## 📞 Suporte

**Problemas na documentação?**
- Abra uma [issue](https://github.com/frigini/MeAjudaAi/issues)
- Abra uma [issue](https://github.com/frigini/MeAjudaAi/issues)
- 🔄 Sugira melhorias via pull request

**Ajuda com desenvolvimento?**
Expand All @@ -230,5 +130,4 @@ docs/
---

*📅 Última atualização: 14 de Novembro de 2025*
*✨ Documentação reorganizada e consolidada pela equipe MeAjudaAi*
*📂 Arquivos reorganizados: guias → docs/guides/, relatórios → docs/reports/*
*✨ Documentação reorganizada e consolidada pela equipe MeAjudaAi*
132 changes: 0 additions & 132 deletions docs/ROADMAP.md

This file was deleted.

Loading