COVID-19 Tracking API

This is a Laravel-powered API source for tracking COVID-19 cases in a region. It is currently used by the COVID-19 Tracker Canada project.

See it in action at https://api.covid19tracker.ca

Getting Started

Prerequisites

A hosting environment configured for Laravel 7.x should have no issues. Please see Laravel's Server Requirements for up-to-date information.

MySQL Database

Data is stored in a MySQL database. You will need to create one for this project to use.

Homestead

Laravel Homestead is also supported out of box for local development.

Important In order to use the CSV Seeders, you must have PHP 7.4 installed. Most deployments typically install version 7.2.

Installing

1. Clone project

git clone [email protected]:andrewthong/covid19tracker-api.git
cd covid19tracker-api

2. Install Dependencies

composer install

3. Configure Environment

cp .env.example .env

Modify the .env with the proper database credentials.

Generate Key

php artisan key:generate

Run Migrations

php artisan migrate

Deployment

You can now launch. Instructions vary depending on your setup (LEMP server, Homestead...)

Seeding Data

Working on it...

Data Management

Admin panel still under consideration.

Built With

• Laravel - The web framework used

Contributing

Feel free to contribute :)

Authors

• Andrew Thong - Initial work - GitHub

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License.

Acknowledgments

• COVID-19 Tracker Canada - the tracker that inspired this project
• Adminer - convenient single-line database administration
• DigitalOcean Hub for Good - infrastructure