Skip to content

Commit de79663

Browse files
authored
Update README.md
1 parent 957e9bd commit de79663

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

README.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,52 @@
1-
# statuspage-backend
1+
![Banner](https://imgur.com/GiItIH7.png)
22

3+
# We Are #CheckOn.
34

4-
# requirements
5-
docker
6-
nodejs
5+
[![GitHub stars](https://img.shields.io/github/stars/StatuspageNZ/statuspage)](https://github.com/StatuspageNZ/statuspage/stargazers)
6+
![YouTube Video Views](https://img.shields.io/youtube/views/igj843wKGdo?style=social)
77

8-
# to run
8+
#### The status page for your suburb
9+
10+
In 2020 we suffer from information overload and face a community transmission of fake news. _1 in 3 people don't know where to get official stats._
11+
12+
#### Information is power!
13+
14+
_Check On_ delivers a calm, actionable single source of truth for you and your suburb. It is a dynamic status page aggregating qualitative information from over 20 public agency and private institution data sources.
15+
16+
It is easy to tell when things are going well. When they aren't we direct you to the source of information. We integrate state-of-the-art and industry-leading Machine Learning to prioritise essential information
17+
18+
### Getting Up & Running
19+
20+
#### Requirements
21+
- Docker
22+
- NodeJS
23+
24+
#### Commands
25+
26+
In the root folder, run:
927

10-
in root folder run
1128
```
1229
docker-compose up -d
1330
cd src
1431
npm install
1532
node index.js
1633
```
1734

18-
# problems
35+
If you have a local MongoDB running, this will not work. If you're on a macOS system, run: `$ sudo service mongod stop`
36+
37+
### 🎥 Watch our Video
38+
39+
[![Demo](https://img.youtube.com/vi/igj843wKGdo/0.jpg)](https://www.youtube.com/watch?v=igj843wKGdo)
40+
41+
### 📸 Team #CheckOn
1942

20-
if you have a local mongodb running this will not work, if your on mac run this (FOR WALT LOL)
21-
Screw you Will, I dont let it persist when not in use 😅(For Will)
43+
![Screenshot](https://imgur.com/qipU8zR.png)
2244

23-
sudo service mongod stop
45+
Our team (top left to bottom right):
46+
[Ilia Sidorenko](https://www.linkedin.com/in/ilia-sidorenko/),
47+
[Jackson Lawrence](https://www.linkedin.com/in/jklawrence/),
48+
[Caity Butcher](https://www.linkedin.com/in/caitybutcher/),
49+
[Minh Phu Lai](https://www.linkedin.com/in/minh-phu-lai/),
50+
[Olaf Wrieden](https://www.linkedin.com/in/olafwrieden/),
51+
[Walter Lim](https://www.linkedin.com/in/waltzaround/),
52+
[William Seagar](https://www.linkedin.com/in/william-seagar-50512614b/)

0 commit comments

Comments
 (0)