Corona Tracker

🦠 Python Project COVID-19 Tracker 🦠

Cases COVID-19 in Brazil and in the World

Copyright (c)

Lucca Pessoa da Silva Matos (c) 2020 - GitHub Repository

Getting Started

To use this repository you need to make a git clone:

git clone --depth 1 https://github.com/lpmatos/corona-api-tracker.git -b master

Pull requests are welcome. If you'd like to support the work and buy me a ☕, I greatly appreciate it!

Organization

• /code in this folder we have the application.
• /docs is the directory where we have all documentation files.
• CHANGELOG.md is a versioning file usend to control development versions.
• docker-compose.yml is the Docker container orchestrator.
• Dockerfile is a file used to set up your Docker environment.
• Makefile is a file containing a set of automation policies.
• README.md is an optional file. A human-readable README file..
• The files found in the project root are support files to others contexts.

Description

The idea behind this project is the construction of a simple API that consumes data collected on the current situation of COVID-19 in the world, presenting, in addition to a simple view on the cases, a view with details referring to each region/country of the country according to the population quantity.

Pre-Requisites

Tools
Python
Docker
docker-compose

Desenvolvimento sem Docker

Usage

In the directory, install the dependencies.

npm install

Start React development server.

npm start

Await for browser window open in http://localhost:3000.

Deployment

In the directory, install the dependencies.

npm install

Execute build command to create minify version to production.

npm run build

Will be create folder /build with the files. Inserts into HTTP server. More information

Desenvolvimento com Docker

Steps to build the Docker image.

Build

docker image build -t <IMAGE_NAME> -f <PATH_DOCKERFILE> <PATH_CONTEXT_DOCKERFILE>
docker image build -t <IMAGE_NAME> . (This context)

Run

Steps to run the container.

• Linux running:

docker container run -d -p <LOCAL_PORT:CONTAINER_PORT> <IMAGE_NAME> <COMMAND>
docker container run -it --rm --name <CONTAINER_NAME> -p <LOCAL_PORT:CONTAINER_PORT> <IMAGE_NAME> <COMMAND>

• Windows running:

winpty docker.exe container run -it --rm <IMAGE_NAME> <COMMAND>

Exec

Steps to enter inside the container.

docker exec -it <CONTAINER_NAME> <COMMAND>

Cleaning

Steps to clean your Docker environment.

docker system prune -af

• Stop all containers.

docker stop $(docker ps -aq)

• Remove all containers.

docker rm $(docker ps -aq)

• Remove all images.

docker rmi $(docker images -a)

• Remove all volumes.

docker volume prune -f

• Remove all network.

docker network prune -f

Environment variables

Name	Description
LOG_PATH	Just the Log Path
LOG_FILE	Just the Log File
LOG_LEVEL	Just the Log Level
LOGGER	Just the Logger name

Built with

• Python
• Docker
• Docker Compose

How to contribute

1. Make a Fork.

2. Follow the project organization.

3. Add the file to the appropriate level folder - If the folder does not exist, create according to the standard.

4. Make the Commit.

5. Open a Pull Request.

6. Wait for your pull request to be accepted.. 🚀

Remember: There is no bad code, there are different views/versions of solving the same problem. 😊

Add to git and push

You must send the project to your GitHub after the modifications

git add -f .
git commit -m "Added - Fixing somethings"
git push origin master

Pomodoro Tasks

• Create the first Dockerfile with multistage builds strategy.
• Test Dockerfile with multistage.
• Create log class and config class.
• Adding exceptions handlers in log class and config class.
• Customize log with coloredlogs.
• Create simple ASCII Art with pyfiglet module.
• Adding request class.
• Adding Bing Corona to get information.

TODO

• Implement country information search using restcountries API.

Links References:

• Projects:

  • https://github.com/pomber/covid19
  • https://github.com/Doc-McCoy/bot-corona-tracker

• Datasets:

  • https://github.com/CSSEGISandData/COVID-19

• APIs:

  • https://restcountries.eu/rest/v2/
  • https://www.bing.com/covid/data
  • https://thevirustracker.com/api

• Strategys:

  • https://blog.realkinetic.com/building-minimal-docker-containers-for-python-applications-37d0272c52f3

Get to Know

Link	Description
Coronavirus	World Health Organization.
Novel coronavirus (COVID-19)	World Health Organization.

Current Status

Link	Description
WHO	World Health Orginization.
CDC	Center for Disease control.

➤ Author

👤 Hey!! If you like this project or if you find some bugs feel free to contact me in my channels:

• Linktree: https://linktr.ee/lpmatos

➤ Versioning

To check the change history, please access the CHANGELOG.md file.

➤ Project status

This repository is a study project, therefore, it will not always be maintained 👻.

➤ Donations

➤ Show your support

Give me a ⭐️ if this project helped you!

Made with 💜 by me 👋 inspired on readme-md-generator