Skip to content

Commit 66f82d5

Browse files
committed
readme latest
1 parent 3ac0e42 commit 66f82d5

1 file changed

Lines changed: 17 additions & 60 deletions

File tree

README.md

Lines changed: 17 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
2020

2121
## What's New?
2222

23-
- Updated microservices example with
23+
- new microservices app
24+
- updated version history with past iteration changes
25+
- Added codebase overview visulization
2426

2527
### With Chronos 13.0
2628

@@ -80,7 +82,8 @@ For more details on the NPM package and instructions for how to use it, please v
8082

8183
## Chronos Desktop Application
8284

83-
### WSL2 Environment
85+
<!-- v13 notes : WSL environment does not work ----------------------------------->
86+
<!-- ### WSL2 Environment
8487
8588
If you wish to launch the Electron Application in an WSL2 envirronment(Ubuntu) you may need the following commands for an Electron window to appear
8689
@@ -96,19 +99,9 @@ sudo apt install libgconf-2-4 libatk1.0-0 libatk-bridge2.0-0 libgdk-pixbuf2.0-0
9699
97100
```
98101
export DISPLAY="`sed -n 's/nameserver //p' /etc/resolv.conf`:0"
99-
```
100-
101-
### Creating User Database
102-
103-
**NOTE: You must create your own user database**
104-
105-
1. Create a MongoDB database in which to store user information and insert it on line 2 within the [UserModel.ts](./electron/models/UserModel.ts) (_electron/models/UserModel.ts_) file.
106-
- This database will privately store user information.
107-
2. Once this is set up, you can create new users, log in, and have your data persist between sessions.
108-
109-
#
102+
``` -->
110103

111-
### Running the Chronos desktop app in development mode
104+
### Running the Chronos desktop app in development mode (WSL Incompatible)
112105

113106
1. From the root directory, run `npm install`
114107
2. Run `npm run build`
@@ -127,6 +120,16 @@ export DISPLAY="`sed -n 's/nameserver //p' /etc/resolv.conf`:0"
127120

128121
#
129122

123+
### Creating User Database
124+
125+
**NOTE: You must create your own user database for extended features**
126+
127+
1. Create a MongoDB database in which to store user information and insert it on line 2 within the [UserModel.ts](./electron/models/UserModel.ts) (_electron/models/UserModel.ts_) file.
128+
- This database will privately store user information.
129+
2. Once this is set up, you can create new users, log in, and have your data persist between sessions.
130+
131+
#
132+
130133
# Examples
131134

132135
We provide eight example applications for you to test out both the Chronos NPM package and the Chronos desktop application:
@@ -371,52 +374,6 @@ Updates:
371374
</ul>
372375
</details>
373376

374-
<details><summary>Chronos ??</summary>
375-
<ul>
376-
<div>
377-
378-
Contributors:
379-
[Tim Lee](https://github.com/timlee12),
380-
[Taylor Zhang](https://github.com/taylrzhang),
381-
[Snow Bai](https://github.com/xueapp),
382-
[Roberto Meloni](https://github.com/RobertoRueMeloni)
383-
384-
</div>
385-
Updates:
386-
<ul>
387-
<li>Created npm package to allow use of AWS services to be monitored with the application</li>
388-
</ul>
389-
390-
<a href='https://derekquoc.medium.com/monitoring-node-js-grpc-microservices-with-chronos-deac9b227122'>Medium Article</a>
391-
392-
</ul>
393-
</details>
394-
395-
<details><summary>Chronos ??</summary>
396-
<ul>
397-
<div>
398-
399-
Contributors:
400-
[Gahl Peled](https://github.com/GP3-RS),
401-
[Josh James](https://github.com/joshjames289),
402-
[Elisa Nie](https://github.com/elisanie),
403-
Troy Prejusa
404-
405-
</div>
406-
Updates:
407-
<ul>
408-
<li>Distributed tracing across microservice example application</li>
409-
<li>Compatible with GraphQL</li>
410-
<li>Cross-Platform desktop application</li>
411-
<li>Supports PostgresQL and MongoDB databases</li>
412-
<li>Displays real-time metrics</li>
413-
</ul>
414-
415-
<a href='https://medium.com/@jj289_55613/chronos-application-health-monitoring-for-the-modern-era-3b9d93b59ff'>Medium Article</a>
416-
417-
</ul>
418-
</details>
419-
420377
#### Past [Contributors](contributors.md)
421378

422379
#

0 commit comments

Comments
 (0)