scovid19.xyz

The new and improved Scottish COVID-19 tracker.

Built with

• flask
• jinja
• Bulma
• NHS OpenData API
• Chart.js
• flatpickr
• Plausible Analytics

How to

The following instructions use docker, if you'd rather not use docker then see docs/WITHOUT_DOCKER.md.
The first time you run the container and sqlite file database will be created and populated with the data.

This will update on a cron schedule so if you're container isn't always running remember to update this manually.

Running with docker-compose

# Dependencies
sudo apt install docker docker-compose sqlite3

# Enable BuildKit
export DOCKER_BUILDKIT=1
export COMPOSE_DOCKER_CLI_BUILD=1
export BUILDKIT_PROGRESS=plain

# Make an empty .env file
# The secrets are only needed for the twitter bot (see below)
touch .env

# Start the container in dev mode
# Runs on http://localhost:4001 or http://localhost:4002
docker-compose up -d --build scovid

# Logs
docker logs --tail 200 -f scovid

# Populate/update database
docker exec -it scovid tools/update_db.py

# Tests
docker exec -it scovid pytest

# Post tweet - does not post if stats are the same
docker exec -it scovid python3 -m app.scripts.tweet [--dry-run]

Deploy

# Dependencies
sudo apt install docker docker-compose nginx certbot
sudo systemctl enable docker
sudo systemctl start docker

# run
docker compose -f docker-compose.yml up -d --build scovid

# nginx
sudo cp nginx/scovid19.xyz /etc/nginx/sites-available/
sudo ln -s /etc/nginx/sites-available/scovid19.xyz /etc/nginx/sites-enabled/
sudo service nginx restart

# Certbot
sudo certbot --nginx

# Update
# Uses docker-compose scaling to deploy without downtime
git pull
./tools/deploy.sh

Secrets

Currently the only secrets are for the Twitter bot, so you only need to set them if you are working on that, they are:

SCOVID_TWITTER_API_KEY=
SCOVID_TWITTER_API_SECRET=
SCOVID_TWITTER_ACCESS_TOKEN=
SCOVID_TWITTER_ACCESS_SECRET=

Notes

Open Data API reference:
https://docs.ckan.org/en/latest/maintaining/datastore.html#api-reference