Skip to content

Commit f58c647

Browse files
authored
README
1 parent 4326152 commit f58c647

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<div align="center">
2+
3+
<img src="./jan/static/coronavirus.svg" width="100px"></img>
4+
5+
# `Covid19India News`
6+
7+
[![made-with-python](https://forthebadge.com/images/badges/made-with-python.svg)](https://www.python.org/)
8+
</div>
9+
Covid19India News is a website for local news, trending news and news related to Covid-19 for India. This site also displays COVID spread graphs and news using the following features:
10+
11+
- COVID Help :Updated help and resources available in states and cities.
12+
- COVID Map: Updated India map and graphs illustrating the count of cases in states and districts.
13+
- COVID Local: Updated local and national news related to COVID-19.
14+
15+
16+
17+
-----------------------------------------------
18+
19+
20+
## Screen grabs
21+
22+
<div align="center">
23+
<img src="https://github.com/amisha-w/Covid19India-News/blob/master/gifs/home_search.gif" height ="350px"></img>
24+
<img src="https://github.com/amisha-w/Covid19India-News/blob/master/gifs/covidmap.gif" height ="350px"></img>
25+
<img src="https://github.com/amisha-w/Covid19India-News/blob/master/gifs/covidlocal.gif" height ="350px"></img>
26+
<img src="https://github.com/amisha-w/Covid19India-News/blob/master/gifs/covidhelp.gif" height ="350px"></img>
27+
<img src="https://github.com/amisha-w/Covid19India-News/blob/master/gifs/top.gif" height ="350px"></img>
28+
</div>
29+
30+
31+
-----------------------------------------------
32+
## Getting Started
33+
34+
### Prerequisites
35+
36+
* [Django Framework](https://www.djangoproject.com/)
37+
38+
### API Integrations
39+
40+
41+
* [COVID19India](https://www.covid19india.org/)
42+
* [News API](https://newsapi.org/)
43+
44+
45+
Create a new Django project using this template:
46+
```
47+
$ django-admin.py startproject --template=https://github.com/amisha-w/Covid19India-News/archive/master.zip <project_name>
48+
```
49+
Install the project's dependencies and setup project environment.
50+
51+
```bash
52+
$ cd projectname/
53+
54+
$ virtualenv venv
55+
$ venv/scripts/activate
56+
$ pip install -r requirements.txt
57+
58+
$ python manage.py migrate
59+
$ python manage.py runserver
60+
61+
```
62+
63+
-----------------------------------------------
64+
## Contributions
65+
66+
We're are open to `enhancements` & `bug-fixes`
67+
68+
69+
-----------------------------------------------
70+
## Contributors
71+
* [Amisha Waghela](https://github.com/amisha-w)
72+
73+
-----------------------------------------------
74+
75+
76+
77+
78+
79+
80+

0 commit comments

Comments
 (0)