Skip to content

Commit 195b033

Browse files
committed
Updated readme
1 parent dbe9ee8 commit 195b033

File tree

1 file changed

+55
-6
lines changed

1 file changed

+55
-6
lines changed

Covid Tracker App/README.md

+55-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,60 @@
1-
# Covid Tracker Application
1+
# COVID-19 Tracker App
22

3-
A Covid Tracking Application for India that will fetch information about the current situation of Covid affected people, deaths, etc from an API and
4-
serve them in the frontend.
3+
A desktop application to track the latest COVID-19 information using Python and KivyMD, and RapidAPI for fetching information.
54

5+
## This project is under DWOC'2023
66

7-
## Tools & Languages
7+
![DWOC'2023 Banner](./assets/img/dwoc.png)
88

9-
- Python
9+
## Getting Started
10+
11+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
12+
13+
### Prerequisites
14+
15+
- Python 3.6 or higher
1016
- KivyMD
11-
- RapidAPI
17+
- RapidAPI account
18+
- Python-Dotenv
19+
20+
### Installing
21+
22+
Clone the repository and install the required packages.
23+
24+
```
25+
git clone https://github.com/pooranjoyb/Play-With-Python.git
26+
cd '.\Covid Tracker App\'
27+
pip install -r requirements.txt
28+
```
29+
30+
31+
Create a `.env` file in the **'.\Covid Tracker App\'** directory and add as follows
32+
```
33+
API_KEY="<yout-RapidAPI-key>"
34+
API_HOST="covid-19-coronavirus-statistics.p.rapidapi.com"
35+
```
36+
37+
[Click here to get your API-KEY](https://rapidapi.com/KishCom/api/covid-19-coronavirus-statistics/)
38+
39+
Start the app.
40+
41+
```
42+
python main.py
43+
```
44+
45+
## Built With
46+
47+
- [Python](https://www.python.org) - The programming language used
48+
- [KivyMD](https://kivymd.readthedocs.io/en/latest/index.html) - The GUI framework used
49+
- [RapidAPI](https://rapidapi.com) - The API platform used to fetch information
50+
51+
52+
## Authors
53+
54+
- **[Pooranjoy Bhattacharya](https://github.com/pooranjoyb)** - *Initial work*
55+
56+
57+
## License
58+
59+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
60+

0 commit comments

Comments
 (0)