Skip to content
This repository has been archived by the owner on Jun 21, 2022. It is now read-only.
/ coocook Public archive

👨‍🍳🦉 Web application for collecting recipes and making food plans

License

Notifications You must be signed in to change notification settings

dboehmer/coocook

Repository files navigation

Coocook

build status dishes served license

Web application for collecting recipes and making food plans

Main features

  • collect recipes
  • create food plans
    • simply import dishes from your recipes
  • gather purchase lists
    • convert units to summarize list items
  • print views for whole project and each day
    • including ingredients, cooking instructions
  • special features
    • define maximum shelf life or limit for need to preorder of articles
    • select some ingredients and part of cooking instructions to be done at an earlier meals

Quick start

Get source code:

$ git clone https://github.com/dboehmer/coocook.git
$ cd coocook/

Configure database

Copy the config template share/examples/dbic.yaml to the working directory:

$ cp share/examples/dbic.yaml dbic.yaml

A database from the YAML file other than development or a literal DSN can be configured in coocook_local.yaml. For other possible settings see the default values defined in lib/Coocook.pm.

Run with native Perl (works best on Unix-like Operating Systems)

Prerequisites:

With Ubuntu or Debian Linux:

$ sudo apt-get install cpanminus sqlite3

To install Perl distributions that include C code you’ll probably need a C toolchain and some libraries:

$ sudo apt-get install build-essential
$ sudo apt-get install libssl-dev zlib1g-dev             # for Net::SSLeay
$ sudo apt-get install libexpat1-dev                     # for XML::Parser
$ sudo apt-get install libncurses-dev libreadline-dev    # for Term::ReadLine::Gnu for development mode
$ sudo apt-get install libsqlite3-dev                    # for DBD::SQLite
$ sudo apt-get install libpq-dev                         # for DBD::Pg

Install Perl5 dependencies required for running the application:

$ cpanm --installdeps .

There are a few additional dependencies for development as well recommended and suggested dependencies. To install these as well run:

$ cpanm --installdeps --with-develop --with-recommends --with-suggests .

Install database schema into configured database (see above) and start development server in debug mode:

$ script/coocook_deploy.pl install
$ script/coocook_server.pl --debug
...
HTTP::Server::PSGI: Accepting connections at http://0:3000/

Hint: With the --restart option the development server restarts automatically when files in lib/ are changed. This requires Catalyst::Restarter.

Run with Docker

Follow the instructions at hub.docker.com/r/coocook/coocook-dev to use the Docker image for development.

Mailing list

Terminology

Name Description Example
Project self-contained collection of Coocook data Paris vacation
Meal an occasion for food on a particular date lunch at August 15th
Dish an actual food planned for a certain meal apple pie for lunch on August 15th
Recipe a scalable template for a dish apple pie
Ingredient an amount of some article for a dish/recipe 1kg of apples
Article a single sort of food that can be purchased apples
Unit a type of measurement kilograms
Quantity a collection of physical units that can be converted masses

Author

Daniel Böhmer [email protected]

Contributors

Copyright and License

This software is copyright (c) 2015-2022 by Daniel Böhmer. This web application is free software, licensed under the GNU Affero General Public License, Version 3, 19 November 2007.