dinrplan

Meal planner/recipe database built with Python, Django and htmx. Deployed on dinrplan.fly.dev.

Prerequisites

• Python 3.9+
• PostgreSQL
• hatch

Setting up the development environment

Install PostgreSQL

Make sure to remember the password.

Create a PostgreSQL database

1. Start psql by searching for psql via the Start menu and pressing Enter
2. Press Enter, Enter, Enter, Enter, enter your password, Enter
3. CREATE DATABASE dinrplan;
4. Optionally create a user for the database, or just use the default user.

Create a .env file

cp .env.example .env

Edit the database user and password.

Install dependencies

hatch env create

Install pre-commit

hatch run pre-commit install

Migrate database

hatch run python manage.py migrate

Collect static files

hatch run python manage.py collectstatic

Install playwright

hatch run playwright install

Ensure tests pass

hatch run pytest

Running development server

hatch run server

Running tests

hatch run pytest

After changing database schema, run

hatch run pytest --create-db

to force re-creation of the test database.

Deploying

git push

The project is automatically deployed to dinrplan.fly.dev when the Github Actions pass.