UoN Course Explorer

Flask app for browsing University of Nottingham modules. Uses 23 lines of JavaScript and a cookie. Made for Python 3.12.

Development

Using uv on Windows:

git clone https://github.com/Nottingham-Course-Explorer/uon-course-explorer.git
cd uon-course-explorer
uv sync
uv venv
.venv/Scripts/activate
cd src
set CE_DATABASE=D:\Code\uoncourses.sqlite3
flask run

Set the CE_DATABASE environment variable to the path to your database file.

Deployment

git clone https://github.com/Nottingham-Course-Explorer/uon-course-explorer.git
cd uon-course-explorer
./deploy/deploy.sh [Database URL]

The deployment script downloads your database from the given URL and configures Gunicorn on 127.0.0.1:5100.

Installing Caddy

sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
sudo apt update
sudo apt install caddy