Welcome to the NovelCOVID API
Check out our homepage and sign up for our newsletter here
Recommended by Postman
NovelCovid API is recommended by Postman here
Documentation
NovelCovid API Documentation can be found here
Installation
Without Docker
Redis
- Download redis from https://redis.io/topics/quickstart
- Start redis server using
redis-server
Project
- Fork and clone the git repository
- In the new folder you will find a
example.env
file, duplicate it and rename it to.env
only. - in the new
.env
file, changeREDIS_HOST
to localhost - Change the env variables to fit your environment (leave them blank for default values)
- In one window run
redis-server
- In another window run
npm run start:dev
- Open your browser and navigate to
localhost:{PORT}
(PORT being the port specified in your.env
file) - You should now see the APIs landing page
With docker-compose
- Fork and clone the git repository
- In the new folder you will find a
example.env
file, duplicate it and rename it to.env
only. - Change the env variables to fit your environment (leave them blank for default values)
- Run
npm run docker-start-dev
to run the local version of the API with Docker - Run
npm run docker-start
to run the published version of the API with Docker
Recommended Javascript Wrapper
For further support, you can join our discord server! More Tutorials can be found there too! https://discord.gg/cEDxzfW
Showcases (Awesome-NovelCOVID)
Did you build a project with our API? We now offer an "awesome-list" for you to add your projects into so people can find out about them!
here.
You can find itSources:
https://github.com/CSSEGISandData/COVID-19/tree/master/csse_covid_19_data/csse_covid_19_time_series
https://www.canada.ca/en/public-health/services/diseases/2019-novel-coronavirus-infection.html
https://www.rki.de/DE/Content/InfAZ/N/Neuartiges_Coronavirus/Situationsberichte/Gesamt.html
Contributors ✨
Thanks goes to these wonderful people (emoji key):
EliteDaMyth 💻 |
Ethan Winters 🐛 💻 |
dicedtomato 💻 |
apollyon600 📖 |
James Shelley 👀 |
Ryan Harlow 🐛 |
Ali Tas 🐛 |
Walter Corrales 💻 |
Ahmad Awais ⚡️ 📖 |
MrAugu 🐛 |
Ayyan Lewis 🐛 |
Ben Sommer 🐛 💻 |
Luis De Anda 📖 |
puf17640 🐛 💻 |
Oluka Denis 🐛 |