OssamaRafique / API

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub contributors ESLint Tests GitHub top language GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests Discord

Join our Server!

Discord 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.

NPM Package

Version Size Downloads

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

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

JavaScript:

const { NovelCovid } = require('novelcovid');

TypeScript:

import { NovelCovid } from 'novelcovid';

Methods

Everything is listed on the npm site.

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

πŸ› πŸ’»

Luis De Anda

πŸ“–

puf17640

πŸ’»

Oluka Denis

πŸ›

Donating

Buy Me A Coffee

License

FOSSA Status

About

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

License:GNU General Public License v3.0


Languages

Language:JavaScript 90.7%Language:CSS 5.3%Language:HTML 3.9%Language:Dockerfile 0.1%