Cookbook

A personal recipe management and meal planner app.

Demo

A demo of the app is available at cookbook.codemu.ch. You will need to register a user account to access it.

Development

1. Install the project.

git clone git@github.com:cmvanb/cookbook.git
cd cookbook
python -m venv venv
source venv/bin/activate
pip install -r cookbook/requirements.txt

2. Initialize the database.

FLASK_APP=cookbook:app flask init-db

3. Run the local development server.

FLASK_APP=cookbook:app flask --debug run

4. Alternatively, use the docker dev deployment.

docker compose -f deployment/dev.yml up --build

5. Navigate to localhost:5000.

Tests

1. Run the tests.

coverage run -m pytest

2. Generate a coverage report.

coverage report

Deployment with Docker

1. Copy example.env and rename it to .env.

cp deployment/example.env deployment/.env

2. Edit the .env file to set the Flask secret key.

3. Build and run the image.

docker compose -f deployment/demo.yml up --build