a minimal RESTful web application powered by Flask and MariaDB
Click to view environment setup (optional)
This repo uses Python and was scaffolded using uv
, a Rust-based package manager. Use one of the following to install it on your machine:
macOS/Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh
Windows:
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
Docker is also required to run the associated backend services. Setup instructions can be found here.
-
Create a new local virtual environment:
uv venv
-
Activate virtual environment (on Linux):
source .venv/bin/activate
-
Install project dependencies:
uv pip install -r requirements.txt
-
Deploy containers:
docker-compose up -d
-
And serve!
flask run
The Flask server is now running at http://localhost:5000 and the Database can be accessed directly via PHPMyAdmin at http://localhost:8080. The default username/password is root
/changeme
.