Recommend setting up on Linux, macOS, or WSL. Windows can be problematic. Below assumes some basic installs (python, pip, venv, node, npm, pyenv)

Clone the repository

git clone <black-rod repo>
cd black-rod

Ensure SQLite 3 is installed (skip if already installed)

For Ubuntu/Debian-based systems:

sudo apt update && sudo apt install -y sqlite3

For macOS using Homebrew:

brew install sqlite

For Windows: Download the installer from SQLite Downloads and follow the instructions.

Install pyenv if you haven't already, or install the version of python listed in .python-version and verify its being used in your repo

Set up the Python virtual environment

Make sure to use python3 for the virtual environment:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Set up Webpack assets

nvm use 20
npm install
npm run build

Load test data (Username: tab, Password: password)

python manage.py -d makemigrations
python manage.py -d migrate
python3 manage.py -d loaddata dev_fixtures

Create an admin user

python manage.py makesuperuser

Simultaneously run Webpack and the Python server

./bin/dev-server