Skip to content

Commit 57af44b

Browse files
committed
Update README
1 parent c89b9bb commit 57af44b

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Task Service
22

3-
Task Service is a sample application used to handle Tasks by User. The base structure of a `Task` is:
3+
Task Service is a sample application used to handle Tasks by User. The goal here is to show in a simple project how I enjoy desigin and implementing the solutions I have creates after a few yeras of experience working with NodeJs. I am always open mind to change it since there is no silver bullet from my perspective.
4+
5+
The base structure of a `Task` is:
46

57
```typescript
68
{
@@ -17,6 +19,20 @@ The REST API / GraphQL API is protected by user authentication using a `bearer`
1719

1820
⚠️ **Important**: There is 2 types of user. A `super` user that can handle all the tasks and a `non-super` user which can only handle its own tasks. You may get some `401` or `403` errors if you try to acccess wrong IDs.
1921

22+
Here is a structure of a `User`:
23+
24+
```typescript
25+
{
26+
id: string
27+
name: string
28+
username: string
29+
password: string
30+
email: string
31+
createdAt: Date
32+
super: boolean
33+
}
34+
```
35+
2036
## 💻 Stack
2137

2238
The following list represents the main stack and its dependencies:
@@ -48,7 +64,6 @@ docker-compose -f docker-compose-test.yml up -d
4864

4965
It will up database, two instances of the container app and a `nginx` as a load balancer which will distribute the requests across the containers emulating a situation where we have more than a single instance running for the application. The image for the container app is ready and published on docker hub, you can check it here: https://hub.docker.com/r/felipeoriani/tasks-api-nodejs-typescript
5066

51-
5267
```mermaid
5368
flowchart TD
5469
G(Client) -.loadBalancer:4000.-> LB(Nginx Load Balancer)

0 commit comments

Comments
 (0)