Skip to content

Commit b1fdfe8

Browse files
committed
edited gRPC README and added screenshot of reverse proxy, emulating a front end
1 parent 8b7692e commit b1fdfe8

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

assets/gRPC_example_reverseProxy.png

60.1 KB
Loading

examples/gRPC/README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
![Chronos logo](https://raw.githubusercontent.com/Chronos2-0/Chronos/master/app/assets/logo2.png)
2+
23
## Microservices Architecture
34
Microservices architecture for testing [Chronos](https://github.com/open-source-labs/Chronos), a microservice communication and health visualizer.
45

@@ -12,11 +13,11 @@ Each microservice has its own server, which receives requests from both the clie
1213

1314
## Getting Started w/ gRPC Example Microservices
1415

15-
Follow **'main'** branch READ>ME steps: Pre-Installation, Install Dependencies before start.
16+
Follow **'main'** branch README steps: Pre-Installation, Install Dependencies before start.
1617

17-
On each microservice in example/microserivces, perform the following steps
18-
- *Do this for microservices: books, orders, & reverse proxy
19-
- Create a .env file under each microservice folder and input your own Mongodb Atlast URI for Microservice_URI, CHRONOS_URI and ORDER_URI, see example below:
18+
On each microservice in example/microservices, perform the following steps
19+
- **NOTE: Do this for microservices: books, orders, & reverse proxy**
20+
- Create a .env file under each microservice folder and input your own Mongodb Atlas URI for Microservice_URI, CHRONOS_URI and ORDER_URI, see example below:
2021

2122
```
2223
BOOK_URI = mongodb+srv://<username>:<password>@cluster0.o2hx5.mongodb.net/<dbname>?retryWrites=true&w=majority
@@ -27,18 +28,25 @@ ORDER_URI = mongodb+srv://<username>:<password>@cluster0.o2hx5.mongodb.net/<dbna
2728
```
2829
- In each Microservices *chronos-config.js* file, verify that `"mode"` property has a value of `"microservices"`
2930

30-
```
31-
- **Note: The Initialize Chronos step is already taken care of for you.
31+
32+
- ** Note: The Initialize Chronos step is already taken care of for you.
3233
- Inside each microservice directory, install all dependencies using the `npm install`
3334
- Run `npm run start` in each folder directory
34-
- Head over to localhost:3030 to view reverse proxy acting as the frontend of this microservice example
35+
- Head over to localhost:3000 to view reverse proxy acting as the frontend of this microservice example
36+
37+
<p align="center">
38+
<img alt="gRPC reverse proxy front end" src="../../assets/gRPC_example_reverseProxy.png">
39+
</p>
40+
3541
- Start adding data!
3642
- Run `npm run both` to start Electron app
3743
- Add a new application in Chronos app dashboard.
3844
- The URI should be your CHRONOS_URI
3945

4046

41-
**To test the functionality of Chronos using this sample microservices architecture, you must have the [Chronos node module](https://www.npmjs.com/package/chronos-microservice-debugger3) within each microservice. This is already included as a dependency therefore there should be no need to install it manually. But if it is missing from the dependency list, the installation instructions for both the Chronos node module and the Chronos desktop visualizer are below:**
47+
**To test the functionality of Chronos using this sample microservices architecture, you must have the [Chronos node module](https://www.npmjs.com/package/chronos-microservice-debugger3) within each microservice.**
48+
49+
This is already included as a dependency therefore there should be no need to install it manually. But if it is missing from the dependency list, the installation instructions for both the Chronos node module and the Chronos desktop visualizer are below:
4250

4351

4452
#### Electron desktop application
@@ -51,12 +59,6 @@ Inside the downloaded directory, install all dependencies using the `npm install
5159

5260
Chronos hopes to inspire an active community of both users and developers. For questions, comments, or contributions, please submit a pull request.
5361

54-
## People
55-
56-
[Vince Ho](https://github.com/hodesza)
57-
[Matt Jiang](https://github.com/mattljiang)
58-
[Derek Lam](https://github.com/DerekQuoc)
59-
[Kit Loong Yee](https://github.com/kitloong1)
6062
## License
6163

6264
[MIT](LICENSE)

0 commit comments

Comments
 (0)