Skip to content

Commit ee658c5

Browse files
authored
Update README.md
1 parent 0bfb3e1 commit ee658c5

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
This app is composed of three services based on the gRPC protocol: User, Auth, and Quote. These services communicate with each other and clients via the gRPC protocol and admin can manage users(editor) and quotes and users can get random quotes.
44

55
**User Service**
6+
67
The User Service provides functionality related to managing user(quote editor) information.
78
Methods:
89

@@ -12,13 +13,15 @@ Methods:
1213
- removeUser
1314

1415
**Auth Service**
16+
1517
The Auth Service handles user authentication and authorization.
1618
Methods:
1719

1820
- login
1921
- verifyToken
2022

2123
**Quote Service**
24+
2225
The Quote Service retrieves and manages quotes.
2326

2427
- findOneQuoteById
@@ -28,9 +31,11 @@ The Quote Service retrieves and manages quotes.
2831
- updateQuote
2932

3033
**Proto Files**
34+
3135
for more info about methods and input/output types check out proto directory
3236

3337
**API Gateway**
38+
3439
The API Gateway serves as an entry point for clients to communicate with the gRPC services. It translates HTTP requests to gRPC requests and vice versa.
3540

3641
- Port: 3000
@@ -42,13 +47,21 @@ To access the services through the API Gateway, send an HTTP request to the appr
4247
## Demo
4348

4449
![all request](./screenshots/all.png)
50+
4551
![create quote](./screenshots/create_quote.png)
52+
4653
![delete quote](./screenshots/delete_quote.png)
54+
4755
![random quote](./screenshots/quote_random.png)
56+
4857
![quote by id](./screenshots/quote_by_id_not_found.png)
58+
4959
![quote by id](./screenshots/quote_by_id.png)
60+
5061
![update quote](./screenshots/update_quote.png)
62+
5163
![login user](./screenshots/update_quote.png)
64+
5265
![get all users](./screenshots/get_all_users.png)
5366

5467
## Installation
@@ -92,7 +105,7 @@ npm run start:dev quote
92105
npm run start:dev
93106
```
94107

95-
The server will start and listen on port 3000.
108+
The server will start and listen on port **3000**.
96109

97110
## Contributing
98111

0 commit comments

Comments
 (0)