Skip to content

Commit ef3697a

Browse files
lu0713lu0713
committed
README logo & link
1 parent d4a2332 commit ef3697a

1 file changed

Lines changed: 73 additions & 76 deletions

File tree

‎README.md‎

Lines changed: 73 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,6 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
1919

2020
- [Features](#features)
2121
- [Demo](#demo)
22-
- [Branches](#branches)
23-
- [Master](#master)
24-
- [Middleware](#middleware)
25-
- [Microservices](#microservices)
26-
- [Docker](#docker)
27-
- [ChronosWebsite](#chronoswebsite)
28-
- [Others](#others)
2922
- [Installation](#installation)
3023
1. [Pre-Installation](#1.-pre-installation)
3124
2. [Install Dependencies](#2.-install-dependencies)
@@ -34,7 +27,14 @@ Chronos is a comprehensive developer tool that monitors the health and web traff
3427
- [Notifications](#notifications)
3528
- [Slack](#slack)
3629
- [Email](#email)
37-
- [Stack](#stack)
30+
- [Branches](#branches)
31+
- [Master](#master)
32+
- [Middleware](#middleware)
33+
- [Microservices](#microservices)
34+
- [Docker](#docker)
35+
- [ChronosWebsite](#chronoswebsite)
36+
- [Others](#others)
37+
- [Technologies](#technologies)
3838
- [License](#license)
3939

4040
#
@@ -67,72 +67,6 @@ Add text here<br>
6767
###### Return to [Top](#Chronos)
6868
<br>
6969

70-
71-
## Branches
72-
73-
### Master
74-
75-
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.
76-
77-
**NOTE:** To _replace_ or _override_ these two default databases that we provide, change the database URIs stored in the following path:
78-
```
79-
root directory -> electron -> user -> settings.json
80-
```
81-
82-
### Middleware
83-
84-
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.
85-
<br>
86-
<br>
87-
88-
### Microservices
89-
90-
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.
91-
92-
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.
93-
94-
Refer to the [README](https://github.com/oslabs-beta/Chronos/tree/docker/microservice) of that branch for more details.
95-
<br>
96-
<br>
97-
98-
### Docker
99-
100-
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..
101-
102-
<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.
103-
104-
<img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> In order to have container stats saved to your database along with other health info, when starting up the containers, bind volumes to this path:
105-
```
106-
/var/run/docker.sock
107-
```
108-
109-
For example, you can type the following when starting up a container:
110-
```
111-
docker run -v /var/run/docker.sock:/var/run/docker.sock [your-image-tag]
112-
```
113-
114-
If you're using docker-compose to start up multiple containers at once, you can add a `volumes` key for each of your services in the YAML file:
115-
116-
```
117-
volumes:
118-
- "/var/run/docker.sock:/var/run/docker.sock"
119-
```
120-
<br>
121-
122-
### ChronosWebsite
123-
124-
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" />.
125-
<br>
126-
<br>
127-
128-
### Others
129-
130-
Please feel free to ignore the other branches in the repository ('Demo', 'Dev')
131-
#
132-
###### Return to [Top](#Chronos)
133-
<br>
134-
135-
13670
## Installation
13771
This is for the latest Chronos version **5.1 release and later**.
13872

@@ -274,9 +208,72 @@ notifications: [
274208
###### Return to [Top](#Chronos)
275209
<br>
276210

277-
## Stack
211+
## Branches
212+
213+
### Master
214+
215+
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.
216+
217+
**NOTE:** To _replace_ or _override_ these two default databases that we provide, change the database URIs stored in the following path:
218+
```
219+
root directory -> electron -> user -> settings.json
220+
```
221+
222+
### Middleware
223+
224+
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.
225+
<br>
226+
<br>
227+
228+
### Microservices
229+
230+
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.
231+
232+
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.
233+
234+
Refer to the [README](https://github.com/oslabs-beta/Chronos/tree/docker/microservice) of that branch for more details.
235+
<br>
236+
<br>
237+
238+
### Docker
239+
240+
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..
241+
242+
<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.
243+
244+
<img src="./app/assets/important.png" alt="Important" title="Important" align="center" height="20" /> In order to have container stats saved to your database along with other health info, when starting up the containers, bind volumes to this path:
245+
```
246+
/var/run/docker.sock
247+
```
248+
249+
For example, you can type the following when starting up a container:
250+
```
251+
docker run -v /var/run/docker.sock:/var/run/docker.sock [your-image-tag]
252+
```
253+
254+
If you're using docker-compose to start up multiple containers at once, you can add a `volumes` key for each of your services in the YAML file:
255+
256+
```
257+
volumes:
258+
- "/var/run/docker.sock:/var/run/docker.sock"
259+
```
260+
<br>
261+
262+
### ChronosWebsite
263+
264+
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" />.
265+
<br>
266+
<br>
267+
268+
### Others
269+
270+
Please feel free to ignore the other branches in the repository ('Demo', 'Dev')
271+
#
272+
###### Return to [Top](#Chronos)
273+
<br>
274+
275+
## Technologies
278276

279-
Chronos was built using the following technology stacks:
280277
- <img src="./app/assets/electron-logo-color.png" alt="Electron" title="Electron" align="center" height="30" />
281278
- <img src="./app/assets/react-logo-color.png" alt="React" title="React" align="center" height="30" />
282279
- <img src="./app/assets/js-logo-color.png" alt="JavaScript" title="JavaScript" align="center" height="30" />

0 commit comments

Comments
 (0)