DEVELOPMENT.md

Development

Bring up a development environment

Install Prerequisites

Ubuntu / Debian

sudo apt-get update
sudo apt-get install -no-install-recommends -y python3.11 python3.11-venv python3.11-pip python3.11-dev libpq-dev build-essential git

Clone Repo

git clone https://github.com/blogindex/blogindex.xyz

Create a virtual environment and install requirements

cd blogindex.xyz
python3.11 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Nix

If you're running nix you can use the development config provided in nix to bootstrap everything.

nix develop # Evoke development shell
./start.sh # Start the app

Testing

FIXME

At the moment, tests are broken due to the switch from Auth0 to OpenID Connect / Authentik

Automated tests can be run using the docker containers defined in blogindex/ci-tools

Deploying

See docker/blogindex for a docker-compose file to deploy the api for testing