Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
jessicatarra committed Dec 12, 2023
1 parent 3776bb9 commit feb3089
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,39 @@ To understand the initial state of the project, please refer to the [previous RE
### API Docs from V1 application version
https://greenlight.tarralva.com/swagger/index.html

### Diagram
```mermaid
graph LR
subgraph ModularMonolith
subgraph AuthModule
subgraph DomainLayer
D1[Entities]
D2[Value Objects]
end
subgraph ApplicationLayer
A1[Use Cases]
end
subgraph InfrastructureLayer
I1[Repositories]
I2[REST API External Services]
I3[GRPC Internal Service]
end
end
subgraph Legacy Module
subgraph RestServer
RS1[Controllers]
RS2[Handlers]
subgraph Middleware
RS3[Auth GRPC Client]
end
end
subgraph Data Models
end
end
end
```
The diagram represents the initial phase of the refactor process, focusing on separating the auth module from the existing codebase and applying a clean architecture to enhance its maintainability to each new module. The main objective is to isolate the auth module's functionality and ensure that other modules access user-related information and authentication through the internal GRPC auth service.

### TODO
- [x] Implement a modular monolith architecture style
- [ ] Refactor initial implementation into separate modules
Expand Down

0 comments on commit feb3089

Please sign in to comment.