Skip to content

Commit 04dd21f

Browse files
authored
refactor: revise README for improved technical presentation
- Updated README to enhance technical details and clarity.
1 parent d1d24a8 commit 04dd21f

1 file changed

Lines changed: 33 additions & 29 deletions

File tree

README.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# EventFlow API — Enterprise Event Management
2+
![.NET 8](https://img.shields.io/badge/.NET%208-512BD4?style=for-the-badge&logo=dotnet&logoColor=white)
3+
![C#](https://img.shields.io/badge/C%23-%23239120.svg?style=for-the-badge&logo=c-sharp&logoColor=white)
4+
![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white)
5+
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
6+
![Serilog](https://img.shields.io/badge/Serilog-1cb495?style=for-the-badge&logo=serilog&logoColor=white)
7+
![OpenTelemetry](https://img.shields.io/badge/OpenTelemetry-000000?style=for-the-badge&logo=opentelemetry&logoColor=white)
8+
![MicrosoftSQLServer](https://img.shields.io/badge/SQL%20Server-CC2927?style=for-the-badge&logo=microsoft%20sql%20server&logoColor=white)
29

310
O **EventFlow API** é uma solução de back-end **robusta, escalável e orientada a produção** para gestão de eventos, desenvolvida em **.NET 8** e estruturada segundo os princípios da **Clean Architecture**.
411

@@ -29,35 +36,32 @@ graph TD
2936

3037
## 🌟 Diferenciais Técnicos
3138

32-
### ⚡ Cache Distribuído (Redis)
33-
- Implementação do padrão **Cache-Aside**
34-
- Redução significativa de latência em operações de leitura (ex: `GetById`)
35-
- Estratégias de **invalidação de cache** para garantir consistência dos dados
36-
37-
### 🔍 Observabilidade Completa
38-
39-
- **Tracing Distribuído** *(OpenTelemetry + Jaeger)*
40-
Rastreamento ponta-a-ponta das requisições para identificar gargalos entre **API, Cache e Banco de Dados**.
41-
42-
- **Logs Estruturados** *(Serilog + Seq)*
43-
Centralização de logs para diagnóstico rápido em ambientes containerizados.
44-
45-
### 🛡️ Resiliência
46-
- Políticas de **Retry** na conexão com o banco de dados
47-
- Tolerância a falhas transientes
48-
49-
### 🐳 Containerização
50-
- Ambiente totalmente orquestrado via **Docker Compose**:
51-
- API
52-
- SQL Server
53-
- Redis
54-
- Jaeger
55-
- Seq
56-
57-
### 🧼 Clean Code
58-
- Uso de **Primary Constructors**
59-
- **Extension Methods** para configuração de DI (`AppConfiguration`)
60-
- Separação estrita de responsabilidades entre camadas
39+
### ⚡ Performance & Caching
40+
- **Redis (Cache-Aside Pattern)**: Implementação estratégica de cache distribuído para reduzir a carga no banco de dados.
41+
- **Latência Otimizada**: Redução significativa no tempo de resposta em operações de leitura (ex: `GetById`).
42+
- **Consistência**: Estratégias de invalidação de cache (TTL e remoção ativa) para garantir a integridade dos dados.
43+
44+
### 🔍 Observabilidade & Monitoramento
45+
A aplicação foi projetada para não ser uma "caixa preta" em produção:
46+
- **Tracing Distribuído (OpenTelemetry + Jaeger)**: Rastreamento ponta-a-ponta (End-to-End) das requisições, permitindo identificar gargalos exatos entre API, Cache e SQL Server.
47+
- **Logs Estruturados (Serilog + Seq)**: Centralização de logs com enriquecimento de dados, facilitando diagnósticos rápidos em ambiente containerizado.
48+
49+
### 🛡️ Resiliência & Robustez
50+
- **Políticas de Retry**: Resiliência a falhas transientes na conexão com o banco de dados e serviços externos.
51+
- **Health Checks**: Monitoramento da saúde dos contêineres e dependências.
52+
53+
### 🐳 Infraestrutura como Código (IaC)
54+
Ambiente de desenvolvimento totalmente orquestrado via **Docker Compose**, subindo instantaneamente:
55+
- `API (.NET 8)`
56+
- `SQL Server`
57+
- `Redis`
58+
- `Jaeger UI` (Tracing)
59+
- `Seq` (Logging)
60+
61+
### 🧼 Code Quality
62+
- **Modern C#**: Uso de *Primary Constructors* e *Records*.
63+
- **Clean Architecture**: Separação estrita de responsabilidades.
64+
- **DI Otimizada**: Uso de *Extension Methods* para manter a configuração de injeção de dependência limpa e organizada.
6165

6266
---
6367

0 commit comments

Comments
 (0)