sohelkabir / api

API for Current cases and more stuff about COVID-19 or the Novel Coronavirus Strain

Join our Server!

API

API for Current cases and more stuff about COVID-19 or the Novel Coronavirus Strain https://corona.lmao.ninja/

Recommended by Postman

NovelCovid API is recommended by Postman here

Documentation

NovelCovid/API Documentation can be found here

Installation

Redis

1. Download redis from https://redis.io/topics/quickstart
2. Start redis server using redis-server

Project

1. Fork and clone git repository
2. In root project folder, create a new file called config.json
3. Copy contents for config.example.json to new config.json file
4. Replace password field with "" and port field to whatever localhost port you want.
5. From root of project, run npm start
6. In your browser, go to localhost:{port} to test your local changes

Run with docker-compose.

1. Fork and clone git repository
2. In root project folder, make a new file called config.json
3. Copy contents for config.example.json to new config.json file
4. Replace password field with "yourpassword" and port field same within docker-compose.yml.
5. Replace redis host "localhost" with "redis".
6. Run command docker-compose up --build -d.

Loading and using our NPM Package

We suggest you load the module via require, considering ES modules in Node.js are not yet stable.

const covid = require('novelcovid');

Documentation

Executing a method will return a Promise. The examples here utilise async/await to access the data.

// Declare the package
const covid = require('novelcovid');

// Now we create a async/await
(async () => {

    // Now we await it.
    let all = await covid.getAll();

    // Make sure you return it, this usually implies if you are using this inside a function.
    // Use \n to break lines.
    return console.log(`Cases: ${all.cases}\nDeaths: ${all.deaths}\nRecovered: ${all.recovered}`)
})()

Sorting the data.

Some methods can be sorted.

const covid = require('novelcovid');

(async () => {
    let sortedCountries = await covid.getCountry({sort: 'recovered'});
    return console.log(sortedCountries);

    let sortedStates = await covid.getState({sort: 'deaths'});
    return console.log(sortedStates);
})();

Filtering for a specific country/state.

const covid = require('novelcovid');

(async () => {
   // Specific Country
   let specificCountry = await covid.getCountry({country: 'United States'});
   return console.log(specificCountry);

   // Specific State
   let specificState = await covid.getState({state: 'New York'});
   return console.log(specificCountry);
})();

Note Since data.updated returns milliseconds, you can do new Date(data.updated) as it returns an ISO Date

You can read more about new Date() here

For further support, you can join our discord server! More Tutorials can be found there too! https://discord.gg/EvbMshU

Sources:

https://www.worldometers.info/coronavirus/

https://github.com/CSSEGISandData/COVID-19/tree/master/csse_covid_19_data/csse_covid_19_time_series

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 🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome!