Skip to content

cmvanb/cookbook-flask

Repository files navigation

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

Build Test

  1. Install the project.
git clone [email protected]:cmvanb/cookbook.git
cd cookbook
python -m venv venv
source venv/bin/activate
pip install -r cookbook/requirements.txt
  1. Initialize the database.
FLASK_APP=cookbook:app flask init-db
  1. Run the local development server.
FLASK_APP=cookbook:app flask --debug run
  1. Alternatively, use the docker dev deployment.
docker compose -f deployment/dev.yml up --build
  1. Navigate to localhost:5000.

Tests

  1. Run the tests.
coverage run -m pytest
  1. Generate a coverage report.
coverage report

Deployment with Docker

  1. Copy example.env and rename it to .env.
cp deployment/example.env deployment/.env
  1. Edit the .env file to set the Flask secret key.

  2. Build and run the image.

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

About

Recipe management and meal planner app

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published