Skip to content

Latest commit

 

History

History
153 lines (112 loc) · 7.28 KB

README.md

File metadata and controls

153 lines (112 loc) · 7.28 KB

API for exploring covid-19 cases around the globe powered by FastAPI framework

issues forks starts licence build

Introduction

This API provides the information regarding '2019 Novel Coronavirus (covid-19)'. It contains a number of confirmed, death, and recovered cases based on the data provided by the Johns Hopkins University Center for Systems Science and Engineering (JHU CSSE).

Example

Applications

Reference

Branches

Branch Feature Description
master Docker + Web API For deploying to a server
development Docker + Web API For testing before merging to Master

Features

  1. The current data (daily updated)
  2. Confirmed, Deaths, Recovered
  3. The affected countries
  4. Individual affected country
  5. Timeseries

How to Start a Server

  • Go to app directory and Run the following command in your command line to start a server
uvicorn main:app

How to install (Docker-compose)

  • Run the following command in your command line to run the server
docker-compose up
  • Or run the server in the background
docker-compose up -d
  • The port can be changed at docker-compose.override.yml
version: "3"
services:
  web:
    container_name: "covid19_api_web_container"
    volumes:
      - ./app:/app
    ports:
      - "80:80"
    environment:
      - "RUN=uvicorn main:app"

How to install (from Dockerhub)

  • Download the latest image
docker pull nat236919/covid19-api:latest
  • Create a container and run
docker run nat236919/covid19-api

How to use API (v2)

Check it out here

How to use API (v1)

Check it out here

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Nuttaphat Arunoprayoch

🚧 💻 🐛 📖 👀

Sophia Castellarin

💻

Jeremy

💻

Tim

🌍

melsaa

💻

owen-duncan-snobel

💻 📖 💵

Maria Sitkovets

💻

Ali Raeisdanaei

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Sponsor this project

Buy Me A Coffee