Skip to content

Commit 9b85458

Browse files
committed
modifies readme
1 parent 0ad480f commit 9b85458

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
skeleton of a time tracker application
1+
# Time tracker
2+
IOET Time tracker system
3+
4+
## Architecture
5+
The application follows a DDD approach with a hexagonal clean architecture. BIG WORDS!, what does it mean? it means the following:
6+
- We have a directory for each domain entitiy (i.e. time entries, technologies, activities, etc)
7+
- Inside each entity directory we have other 3 directories (application, domain and infrastructure)
8+
- I'll leave this drawing to understand how these three folders work and what logic should be included in these directories:
9+
![DDD design](/ddd.png)
10+
Taken from [Microsoft Docs](https://docs.microsoft.com/en-us/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/ddd-oriented-microservice)
11+
12+
## How to contribute
13+
- Clone the repository, create a new branch, implement the logic taken the architecture into account and create a PR
14+
- Wait for the pipeline to run a be on green
15+
- Please ask for peer review in the #timetracker-collaboration slack channel

ddd.png

206 KB
Loading

0 commit comments

Comments
 (0)