dan/covid
1
0
Fork 0
mirror of https://github.com/danbulant/covid synced 2026-05-19 03:48:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
covid/docs
History
Daniel Bulant 0caa052ab3 Docs for country and global endpoints
2020-03-11 12:50:09 +01:00
..
ENDPOINTS.md Docs for country and global endpoints 2020-03-11 12:50:09 +01:00
README.md Add step to setting up 2020-03-10 11:42:13 +01:00
TYPES.md Docs for country and global endpoints 2020-03-11 12:50:09 +01:00

README.md

Documentation

Requirements

  • NodeJS, tested on v12 and v13
  • CURL (As other ways didn't work when testing)

Setting it up

  • Clone (either using git or hub) this repository
  • Install dependencies (npm i)
  • Fetch data (Must be done at least once, but a cron is suggested)
  • Run it! (npm start)

Format

Every response is in JSON and contains at least these fields:

  • code - HTTP status code
  • type - Type of response, see types
  • data - Might be missing, depends of type.

Endpoints

For list of endpoints, see ENDPOINTS.md