coronaindia/README.md

COVID19 India Tracker, predictive analytics and research. Built by engineers, data scientists, AI and medical professionals.

Introduction
============

[![npm version](https://img.shields.io/badge/npm%20%40elComrades%2Fcoronaindia-v1.0.0-blue)](https://www.npmjs.com/package/coronaindia)
[![CDNJS](https://img.shields.io/badge/cdnjs%20%40elComrades%2Fcoronaindia-v1.0.0-blue)](https://cdnjs.com/libraries/coronaindia)
[![npm version](https://img.shields.io/badge/npm%20%40elComrades%2Fcoronaindia--live--tile-v1.0.0-brightgreen
)](https://www.npmjs.com/package/coronaindia-live-tile)

**coronaindia** is fully responsive dasboard consisting COVID19 India and global Tracker, predictive analytics and research. Built by engineers, data scientists, AI and medical professionals..

**Preview on [coronaindia.github.io](https://coronaindia.github.io)**

<p align="center">
<img src="public/images/coivid19.gif" width="80%">
</p>


Installation
-------
There are multiple ways to install coronaindia.

#### 1. Download From Github releases:

Download from [Github releases](https://github.com/elComrades/coronaindia/releases).

#### 2. Using The Command Line:

- __Via NPM__ (_**Note**: To install it via NPM, you need at least Node.js 10 or higher._)
```bash
npm install coronaindia --save
```
- __Via Git__ (Clone to your machine)
```
git clone https://github.com/elComrades/coronaindia.git
```


Run and deploy locally
-------
To compile Run and deploy locally you need nodejs & npm, clone/download the repo then:

1. `npm install` (install npm deps)
2. `npm run serverstart` (developer mode, with browsersync support for live demo)


Add COVID19 live update plugin on your website.
-------
<p align="center"> <img src="public/images/coivid19-plugins.gif" width="20%"> </p>

#### 1. Via NPM:
```bash
npm install coronaindia-live-tile --save
```

#### 2. Include files:
_The plugin can be added to your website just by including the following to the intended page._
```
<script src="dashboard_plugin/coronaindia.js"> </script>
<link rel="stylesheet" href="dashboard_plugin/coronaindia.css" />
```


Contribution
-------
Contribution are always **welcome and recommended**! Here is how:

- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)).
- Clone to your machine ```git clone https://github.com/YOUR_USERNAME/coronaindia.git```
- Create a new branch
- Make your changes
- Create a pull request


License
-------
coronaindia is an open source project by [elComrades](https://github.com/elComrades) that is licensed under [GPL](https://opensource.org/licenses/gpl-license). elComrades
reserves the right to change the license of future releases.


Maintainers
-------
- [elComrades](https://github.com/orgs/elComrades)
  - [Prashant Mishra](https://github.com/prashantmi)
  - [Deepandu Jain](https://github.com/deepandu)
  - [Siddharth Srivastava](https://github.com/siddharthsrivastava)
  - [Abhijat Chaturvedi](https://github.com/abhijatchaturvedi)
  - [Jatin Asija](https://github.com/jatinasija93)