Skip to content

Commit 7751efc

Browse files
committed
README logo & link
1 parent 1ffe62c commit 7751efc

27 files changed

Lines changed: 39 additions & 22 deletions

README.md

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
3232
- [Notifications](#notifications)
3333
- [Slack](#slack)
3434
- [Email](#email)
35+
- [Stack](#stack)
3536
- [License](#license)
3637

3738
#
@@ -41,10 +42,10 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
4142
## Features
4243

4344
- Distributed tracing enabled across microservices applications
44-
- Supports <img src="./app/assets/http-icon-color.png" alt="HTTP" title="HTTP" align="center" height="20" /> and <img src="./app/assets/grpc-icon-color.png" alt="gRPC" title="gRPC" align="center" height="20" /> protocols
45-
- Compatible with <img src="./app/assets/graphql-icon-color.png" alt="GraphQL" title="GraphQL" align="center" height="20" />
46-
- Provides <img src="./app/assets/docker-icon-color.png" alt="Docker" title="Docker" align="center" height="20" /> container stats (e.g. ID, memory usage %, CPU usage %, running processes, etc.)
47-
- Supports <img src="./app/assets/postgres-icon-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="20" /> and <img src="./app/assets/mongo-icon-color.png" alt="MongoDB" title="MongoDB" align="center" height="20" /> databases
45+
- Supports <img src="./app/assets/http-logo-color.png" alt="HTTP" title="HTTP" align="center" height="20" /> and <img src="./app/assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="20" /> protocols
46+
- Compatible with <img src="./app/assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="20" />
47+
- Provides <img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /> container stats (e.g. ID, memory usage %, CPU usage %, running processes, etc.)
48+
- Supports <img src="./app/assets/postgres-logo-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="20" /> and <img src="./app/assets/mongo-logo-color.png" alt="MongoDB" title="MongoDB" align="center" height="20" /> databases
4849
- Displays real-time temperature, speed, latency, and memory statistics
4950
#
5051
###### Return to [Top](#Chronos)
@@ -62,7 +63,7 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
6263

6364
### Master
6465

65-
The **'master'** branch of this repository is where the <img src="./app/assets/electron-icon-color.png" alt="Electron" title="Electron" align="center" height="20" /> application for Chronos is deployed. The Chronos monitoring tool's _default configuration_ includes two databases: one PostgresQL and one MongoDB, that are both connected and configured for you in the dashboard so you can easily view the metrics and graphs available to you.
66+
The **'master'** branch of this repository is where the <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> application for Chronos is deployed. The Chronos monitoring tool's _default configuration_ includes two databases: one PostgresQL and one MongoDB, that are both connected and configured for you in the dashboard so you can easily view the metrics and graphs available to you.
6667

6768
**NOTE:** To _replace_ or _override_ these two default databases that we provide, change the database URIs stored in the following path:
6869
```
@@ -71,23 +72,23 @@ root directory -> electron -> user -> settings.json
7172

7273
### Middleware
7374

74-
The **'middleware'** branch is what is ultimately deployed to the <img src="./app/assets/npm-icon-color.png" alt="NPM" title="NPM" align="center" height="20" /> package, which is what you will install and configure in your own application in order to use Chronos.
75+
The **'middleware'** branch is what is ultimately deployed to the <img src="./app/assets/npm-logo-color.png" alt="NPM" title="NPM" align="center" height="20" /> package, which is what you will install and configure in your own application in order to use Chronos.
7576
<br>
7677
<br>
7778

7879
### Microservices
7980

80-
The **'dummy-microservice'** branch is where we provide a test suite of sample microservices application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <img src="./app/assets/electron-icon-color.png" alt="Electron" title="Electron" align="center" height="20" /> app.
81+
The **'dummy-microservice'** branch is where we provide a test suite of sample microservices application that successfully utilizes Chronos to apply all the powerful, built-in features of our monitoring tool. You can then visualize the data with the <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" /> app.
8182

82-
The microservices include individual <img src="./app/assets/docker-icon-color.png" alt="Docker" title="Docker" align="center" height="20" />files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
83+
The microservices include individual <img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" />files in their respective directories. A docker-compose.yml is in the root directory in case you'd like to deploy all services together.
8384

8485
Refer to the [README](https://github.com/oslabs-beta/Chronos/tree/docker/microservice) of that branch for more details.
8586
<br>
8687
<br>
8788

8889
### Docker
8990

90-
The '<img src="./app/assets/docker-icon-color.png" alt="Docker" title="Docker" align="center" height="20" /> **/microservice'** branch is where we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience..
91+
The '<img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" /> **/microservice'** branch is where we provide a sample _dockerized_ microservices application to test out Chronos and to apply distributed tracing across different containers for your testing convenience..
9192

9293
<img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> Give your containers the same names you use for arguments for microservice names. Read more about it under the INSTALLATION section below.
9394

@@ -107,14 +108,11 @@ If you're using docker-compose to start up multiple containers at once, you can
107108
volumes:
108109
- "/var/run/docker.sock:/var/run/docker.sock"
109110
```
110-
111-
\*Note: This module leverages the features of [systeminformation](https://systeminformation.io/).
112-
<br>
113111
<br>
114112

115113
### ChronosWebsite
116114

117-
The **'chronosWebsite'** branch is where the source code for the website, chronoslany.com, exists. The website currently has a working download link for Chronos as a desktop application for **MacOS**, and the Windows and Linux download links will redirect you to the <img src="./app/assets/apple-icon-black.png" alt="Apple" title="Apple" align="center" height="15" /> Apple Store to buy a Macbook Pro <img src="./app/assets/macbook-icon-color.png" alt="MacBook" title="MacBook" align="center" height="15" />.
115+
The **'chronosWebsite'** branch is where the source code for the website, chronoslany.com, exists. The website currently has a working download link for Chronos as a desktop application for **MacOS**, and the Windows and Linux download links will redirect you to the <img src="./app/assets/apple-icon-black.png" alt="Apple" title="Apple" align="center" height="15" /> Apple Store to buy a Macbook Pro <img src="./app/assets/macbook-logo-color.png" alt="MacBook" title="MacBook" align="center" height="15" />.
118116
<br>
119117
<br>
120118

@@ -133,9 +131,9 @@ This is for the latest Chronos version **5.1 release and later**.
133131
- LTS release: 5.0.1
134132

135133
### 1. Pre-Installation
136-
Make sure you're running version 12.18.3 of <img src="./app/assets/node-icon-color.png" alt="Node" title="Node" align="center" height="20" />, which is the most recent LTS (long-term support) version.
134+
Make sure you're running version 12.18.3 of <img src="./app/assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" />, which is the most recent LTS (long-term support) version.
137135

138-
If you need to roll back from <img src="./app/assets/node-icon-color.png" alt="Node" title="Node" align="center" height="20" /> 14.9.0, make sure to run
136+
If you need to roll back from <img src="./app/assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" /> 14.9.0, make sure to run
139137
```npm rebuild```
140138
in the root directory.
141139

@@ -209,7 +207,7 @@ Chronos only supports **Slack** and **email** notifications.
209207

210208
### Slack
211209

212-
Chronos uses the <img src="./app/assets/slack-icon-color.png" alt="Slack" title="Slack" align="center" height="20" /> API to send messages to a Slack channel and only requires the **webhook url**. Learn how to set up [Slack webhooks](https://api.slack.com/messaging/webhooks) for your team.
210+
Chronos uses the <img src="./app/assets/slack-logo-color.png" alt="Slack" title="Slack" align="center" height="20" /> API to send messages to a Slack channel and only requires the **webhook url**. Learn how to set up [Slack webhooks](https://api.slack.com/messaging/webhooks) for your team.
213211

214212
An example of configured **slack** settings:
215213

@@ -258,11 +256,30 @@ notifications: [
258256
###### Return to [Top](#Chronos)
259257
<br>
260258

261-
## Electron Desktop Application
262-
263-
After installing the node module in each microservice, download the <img src="./app/assets/electron-icon-color.png" alt="Electron" title="Electron" align="center" height="20" /> desktop application from the public [Chronos]() repo.
264-
265-
Inside the downloaded directory, install all dependencies using the `npm install` command followed by the `npm start` command to start the Electron desktop application.
259+
## Stack
260+
261+
Chronos was built using the following technology stacks:
262+
- <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="20" />
263+
- <img src="./app/assets/react-logo-color.png" alt="React" title="React" align="center" height="17" />
264+
- <img src="./app/assets/js-logo-color.png" alt="JavaScript" title="JavaScript" align="center" height="17" />
265+
- <img src="./app/assets/ts-logo-long-blue.png" alt="TypeScript" title="TypeScript" align="center" height="17" />
266+
- <img src="./app/assets/postgres-logo-color.png" alt="PostgreSQL" title="PostgreSQL" align="center" height="20" />
267+
- <img src="./app/assets/mongo-logo-color.png" alt="MongoDB" title="MongoDB" align="center" height="20" />
268+
- <img src="./app/assets/node-logo-color.png" alt="Node" title="Node" align="center" height="20" />
269+
- <img src="./app/assets/express-logo-color.png" alt="Express" title="Express" align="center" height="20" />
270+
- <img src="./app/assets/http-logo-color.png" alt="HTTP" title="HTTP" align="center" height="20" />
271+
- <img src="./app/assets/grpc-logo-color.png" alt="gRPC" title="gRPC" align="center" height="20" />
272+
- <img src="./app/assets/graphql-logo-color.png" alt="GraphQL" title="GraphQL" align="center" height="20" />
273+
- <img src="./app/assets/docker-logo-color.png" alt="Docker" title="Docker" align="center" height="20" />
274+
- <img src="./app/assets/aws-logo-color.png" alt="AWS" title="AWS" align="center" height="20" />
275+
- <img src="./app/assets/jest-logo-color.png" alt="Jest" title="Jest" align="center" height="20" />
276+
- <img src="./app/assets/enzyme-logo-color.png" alt="Enzyme" title="Enzyme" align="center" height="20" />
277+
- <img src="./app/assets/spectron-logo-color.png" alt="Spectron" title="Spectron" align="center" height="20" />
278+
- <img src="./app/assets/webpack-logo-color.png" alt="Webpack" title="Webpack" align="center" height="20" />
279+
- <img src="./app/assets/material-ui-logo-color.png" alt="Material-UI" title="Material-UI" align="center" height="20" />
280+
- <img src="./app/assets/vis-logo-color.png" alt="Vis.js" title="Vis.js" align="center" height="20" />
281+
- <img src="./app/assets/plotly-logo-color.png" alt="Plotly.js" title="Plotly.js" align="center" height="20" />
282+
266283
#
267284
###### Return to [Top](#Chronos)
268285
<br>
@@ -280,6 +297,6 @@ Development of Chronos is open source on GitHub through the tech accelerator umb
280297

281298
## License
282299

283-
Chronos is <img src="./app/assets/mit-icon-color.png" alt="MIT" title="MIT" align="center" height="20" /> [licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
300+
Chronos is <img src="./app/assets/mit-logo-color.png" alt="MIT" title="MIT" align="center" height="20" /> [licensed.](https://github.com/oslabs-beta/Chronos/blob/master/LICENSE.md)
284301
#
285302
###### Return to [Top](#Chronos)

app/assets/aws-logo-color.png

86.7 KB
Loading

app/assets/enzyme-logo-color.png

112 KB
Loading

app/assets/express-logo-color.png

8.05 KB
Loading

app/assets/jest-logo-color.png

17.7 KB
Loading

0 commit comments

Comments
 (0)