FlashCard Workshop

Prerequisites

• uv for dependency management
• Docker and docker-compose (optional)

Bootstrap

You can either use database in docker compose or locally installed one. For the specific approach refer to the corresponding section.

With the local database

If you want to go with the local database you can make use of the make bootstrap command to install all dependencies and setup the database. For the exact steps refer to the Makefile.

Docker way

If you prefer to use docker then just run:

make bootstrap-docker

Then, you can manage containers with docker compose.

Pre-commit hooks

They are installed as a part of the make bootstrap* commands, but if you want to install them again for some reason, then run:

uv pre-commit install --install-hooks

Usage

The project ships with a default user admin:admin321! in fixtures

Installing dependencies

For managing dependencies, we use uv.

To install all dependencies, run:

uv sync

To add a new dependency:

uv add [--group <group>] <package>

Applying migrations

To apply migrations, run:

uv run python manage.py migrate

or

make migrate

Loading fixtures

uv run python manage.py loaddata fixtures/*.yaml

or

make load-fixtures

Running the server

uv run python manage.py runserver

or just

make