dboehmer/coocook

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

Coocook

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:

• Perl5 with cpanm

• database

  • by default SQLite with DBD::SQLite

  • or PostgreSQL with DBD::Pg

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

• [email protected]
• subscribe at lists.coocook.org/mailman/listinfo/coocook
• or send an email with subject subscribe to [email protected]

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

• @ChristinaSi Christina Sixtus
• @moseschmiedel Mose Schmiedel
• @rico-hengst Rico Hengst

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.

coocook's Issues

Make Travis CI work

I have a new account at travis-ci.org but Coocook fails to build due to travis.yaml (?) missing.

Add keyboard combinations for common actions

Gray background of prepared ingredients in print view of day is not printed

Browsers ignore background images and colors while printing.

How to print the print view without the green background of the program but with any type of markup of the prepared ingredients?

Other ideas:

• add a key below the table
• use some kind of markup that's visible on most basic black & white printers

Add print view with all print views combined

It's tedious to click all day plans and purchase lists and print each one.

Add a form to select days and purchase lists to display and render a page with all of them.

Important: use CSS page-break-before to split the lists on different pages as when they were rendered seperately. https://developer.mozilla.org/en-US/docs/Web/CSS/page-break-before

Add preorder list per purchase list with items which need preordering

Under /print

Add button to delete project

In the project overview there should be a possibility to delete projects, perhaps with a warning and a second confirmation.

Prevent removing units from articles which are used in recipe/dish ingredients

Prevent removing an applicable unit from an article if it is being used for any recipe or ingredient.

Changing dish ingredients doesn't affect purchase list item's value

Steps to reproduce:

1. create dish with ingredient
2. add ingredient to purchase list
3. change value of ingredient

Actual result: purchase list item still holds old value

Expected result: purchase list item is updated

Open questions: How to handle purchase list items with value changed by hand, e.g. ceiled number? Maybe save if value was edited by hand and warn if?

Reduce units and prefill comment when selecting article to add to recipe

When changing the select box of the article to add to the recipe

• the units should be reduced to the ones applicable to the article
• the comment field should be prefilled with the article comment

Change incrementation of number input element at recipes

The value of ingredients increments at the third decimal place by klicking up. That's not wanted behavior.

Add button to delete dish ingredient from purchase list

Update README.md for Github

• description
• remove Catalyst template
• mailing list
• (link to public instance)
• (((public demo which is wiped hourly for access without registration)))

Create a deployment script for setting up the database

Sowas in der Art wolltest du noch machen oder die Config für das Generieren der Tabellen oder so.

Fix warning in Controller::Recipe

"my" variable $input_okay masks earlier declaration in same statement at /home/daniel/workspace/coocook/script/../lib/Coocook/Controller/Recipe.pm line 73, line 1.

You just have to look for multiple my $input_okay statements. Can you fix that?

Add half space if prepend space is not checked

In units view add half space by default if checkbox is not checked.

Avoid empty name fields

Show date of preparation meal for unassigned item that's part of preparation

Steps to reproduce:

1. create meal A and meal B
2. create dish for meal B, prepared at meal A
3. create dish ingredients, one part of preparation

Actual result: "ingredient, dish on date B"

Expected result: "ingredient, prepared on date A, dish on date B"

Validate number input fields

Even without I18n we should validate number input fields and reject inputs with wrong format or cast them into numbers.

Currently causes exception on the units page when adding a unit with conversion factor containing a comma like 0,001.

Project editor: nested forms with dish deletion and meal update don't work

Firefox correctly claims that nested <form>s don't work. I didn't test other browsers yet.

Problem in the project editor is that the list of meals & dishes is a large table. The are small forms inside the table to edit meals and dishes. Also there is a larger outer form to delete selected dishes.

• Originally the first form in the table doesn't work because Firefox deems it invalid. All remaining forms work.
• As a workaround I put <form></form> inside the outer form above the table. Now all inner forms work but the outer one is broken because the <form> is deemed invalid and </form> closes the outer form.

How to fix this? Ideas:

• work with 1 super form submitting to 1 master controller method and different submit buttons with distinguishable identifiers
• redesign the whole page which is bloated anyway

Allow adding custom columns to project overview print view

Actual feature request: print project overview with additional columns for cooking and cleaning dishes.

Idea: generically allow adding custom columns which are empty.

Add filter and sort capabilities to list of unassigned items

Maybe with DataTables? https://datatables.net/

Filter by:

• unit
• day of use

Sort by:

• article name
• shop section
• dish name
• value
• unit name

Create standard footer

Add footer and supply standard content for it.

Error message or warning when adding articles w/o unit to recipe/dish

Below recipes/dishes there is a form for adding articles. We need to somehow handle articles without name. That could mean:

• hide these articles
• disable the select option for these articles
• prevent form submit if such article is selected
• display error message instead of performing request

Edit design of error message

In the new surface the error message is displayed in the header. Put it in the content part and change its look.

Adjust original recipe when changing dish

When the dish in the current plan is changed one should be able to adjust the original recipe accordingly.

I imagine two buttons:

1. update recipe (=remove all recipe ingredients, copy new dish ingredients to recipe, update description etc.)
2. save as new recipe

Repair unit tests

Autocompletion at tags for articles

At articles page add autocompletion of tags.

Show meal's comment in print view for day

like on 17.7. in project SOLA Carina

Supply default error page

Add template and controller for default error page.

Apply FOSS license

Coocook should be free and open source software (FOSS).

• choose license
• create LICENSE file
• tag license on Github
• add/update (if desired) or remove license comments in source files

Offer user registration as self-service

Finish and upload changes in database

You made some changes in the database, especially the added columns that reference projects. Please push your changes and merge your extra branch so that I can continue to work.

Delete data with project

Offer selection of optional print data

Optional print data:

• project overview
  • project
  • comments for dishes
  • comments for meals
• day
  • comments for meals
  • comments for dishes
  • comments for ingredients
• purchase list
  • related ingredients at all
    • name of dish
    • name/date of meal
    • comments for ingredients
  • comments for items

Add generic way to display error messages

Any controller that throws an error should be able to pass an error message when redirecting to another page.

UI hint when adding ingredient to recipe and input fields above are changed

When editing a recipe one can either edit existing ingredients or add another ingredient.

Lina wants a warning or other UI hint when changing existing ingredients and then adding another ingredient.

Non-linear calculation of ingredients

From SOLA Lippe:

Ich habe von unserem Sola-Koch aus der ersten Sola-Woche gehört, dass die nötige Menge an Salz und Gewürzen nicht proportional mit der Menge steigen soll, sondern dass bei größeren Mengen weniger nötig ist. D. h. es liegt nicht mehr ein linearer Zusammenhang vor. Ich kenne leider keine neue Formel.

This is not a must-have for now but should be kept in mind. But I think we can't do that right now. If we ever implement this, we'll just need to change the database and have a migration.

Transform article page into table, add extra page for editing articles

Like unit page already is.

• display articles in table (future: can be filtered)
• offer button/link to edit article
• add extra page for display and editing 1 article

Handle purchase list item when deleting meal, dish or dish ingredient

Should the delete action be prohibited or what should be done with the purchase list item?

Caution: Not yet implemented but planned is that the purchase list item can have an offset, e.g. to get a rounded value. Example: 400g + 0.5kg = 0.9kg. An offset of +0.1kg is used to get exactly 1kg. Now if 400g is deleted 0.5kg+0.1kg remains …

Add function to import data from other projects

There is one import dialog:
You can choose the project to import data from.
There are several options which part of the project you want to import:

• units

• units, recipes, articles -> additionally you can choose if you want to import recipes and articles with their tags

• units, articles -> additionally you can choose if you want to import articles with their tags

Additionally you can choose if you want to import the following:

• shop sections

• tags

You can not import meals.

Avoid projects without name

At the moment you can add projects without a name. Check if there is a name before creating a project. Otherwise stop it and give a hint to the user that he has to insert a name first.

Validate dates before saving to database

Currently the date format YYYY-MM-DD is expected and passed to the database as is.

• in Controller::Meal->create
• in Controller::PurchaseList->create

Thanks to DBIx-Class this is not a security risk because any value is still escaped.

Add user entity and link projects to user(s)

Link project to 1 user with acess permissions or link project to multiple users with roles, e.g. admin or simple user.

Add suggestion of tag group at articles page

Add function to choose a tag group and get suggestion of underlying tags at articles page.

Add print button to print views

For everyone unable to find the print dialog in their browser or press Ctrl+P;-)

How to trigger the print dialog from HTML/JS?

Transform articles, units, … pages into subpages of project

The select button in the project overview has no real benefit at the moment. Change it so that you can really select projects with it or delete it.

Add comment field to recipes

Add plain text field to recipes to add comments concerning experiences and long remarks.
Alternatives:

• one additional text box like preparation and description

• comment input box to add comment to a list of comments (like in github)

Think about printing, if you can choose to add these comments.

Add internationalization (I18n)

• add translation code
• add texts translated to German
• localize number and date formats
• show errors if input fields have invalid format

Install public, open Coocook instance on cool domain

Add developer documentation

Think about how to document the project and which elements to provide additionally.