Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jessicatarra authored Jan 2, 2024
1 parent 5d979a2 commit 70e5ad2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
## Refactoring Greenlight application

[![Go Coverage](https://github.com/jessicatarra/refactoring-greenlight/wiki/coverage.svg)](https://raw.githack.com/wiki/jessicatarra/refactoring-greenlight/coverage.html)

## Refactoring Greenlight application

This project aims to refactor the Greenlight application by implementing clean architecture and SOLID principles. The goal is to improve the codebase's maintainability, scalability, and testability while increasing test coverage.

To understand the initial state of the project, please refer to the [previous README file](https://github.com/jessicatarra/greenlight/blob/main/README.md) or check the [API Docs](https://greenlight.tarralva.com/swagger/index.html) from V1 application version.
Expand Down Expand Up @@ -43,11 +44,11 @@ The diagram represents the initial phase of the refactor process, focusing on se
### TODO
- [x] Implement a modular monolith architecture style
- [ ] Refactor initial implementation into separate modules
- [ ] Add an authentication module
- [x] Add an authentication module
- [x] Implement the create user feature
- [x] Implement the activate user feature
- [x] Implement the create authentication token feature
- [ ] Create auth specific middleware
- [x] Create auth gRPC methods
- [ ] Add a movies module
- [ ] Add a healthcheck module
- [x] Refactor multiple functionalities into internal packages
Expand All @@ -63,7 +64,7 @@ The diagram represents the initial phase of the refactor process, focusing on se
- [x] Add errors package
- [x] Add config package
- [x] Add shared middleware package

### References

- https://github.com/golang-standards/project-layout
Expand Down

0 comments on commit 70e5ad2

Please sign in to comment.