Skip to content

Commit 77aeddd

Browse files
Create README.md
1 parent 73ddb80 commit 77aeddd

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Corona API
2+
> Covid 19 api
3+
4+
## Build Setup
5+
6+
```bash
7+
# install dependencies
8+
$ npm install
9+
10+
#run locally and serve with hot reload at localhost:5000
11+
$ npm run dev
12+
13+
```
14+
15+
## Endpoints
16+
> Combined Data
17+
* https://rona-api.herokuapp.com/ ➡️ all countries data
18+
* [https://rona-api.herokuapp.com/{country}](https://rona-api.herokuapp.com/kenya) ➡️ single country data
19+
20+
> Repoted Cases
21+
* https://rona-api.herokuapp.com/reported ➡️ all countries data
22+
* [https://rona-api.herokuapp.com/reported/{country}](https://rona-api.herokuapp.com/reported/kenya) ➡️ single country data
23+
24+
> Deaths
25+
* https://rona-api.herokuapp.com/deaths ➡️ all countries data
26+
* [https://rona-api.herokuapp.com/deaths/{country}](https://rona-api.herokuapp.com/deaths/kenya) ➡️ single country data
27+
28+
29+
## Data Sources
30+
[world meters](https://https://www.worldometers.info/coronavirus/)
31+
[CSSEGISandData](https://github.com/CSSEGISandData/COVID-19/tree/master/csse_covid_19_data)
32+
33+
34+
35+
36+
37+
38+
# Licence
39+
[MIT](https://github.com/Opensource-254/corona-api/blob/master/LICENSE)
40+

0 commit comments

Comments
 (0)