KRecipes

From KDE Wiki Sandbox
Revision as of 22:56, 10 November 2014 by Vinzenz (talk | contribs) (initial version)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
KRecipes
 Krecipes is a new Open Source project for an exciting world that is almost forgotten in the Tux world: COOKING (yummy! ;-)

Overview

The goal of this projects was (note that we're talking about 2003) to create a KDE Recipe Tool that:

  • Can manage a recipe database with an easy to use interface
  • Allows creation/removal of new ingredients and units
  • Helps with diets, calculating amount of calories, vitamines, carbohydrates... per recipe
  • Creates shopping lists, and daily suggestions for a given diet type
  • Is based on MySQL (1) so it could be possible to generate a KSN(2)
  • Should be as flexible as possible to have the possibility to extend it in future.

Now those goals have been pushed even further, so we have support for other databases like SQLite and PostgreSQL and it includes many other new features. The KSN stuff is still not available, but not too far away. Just wait :)

1. The project has initially started with MySQL, but QSQL provides sufficient flexibility to hopefully port this project for other databases.

2. KSN: Krecipe Servers Network ;-)

Krecipes Features

For a complete look into Krecipes, check out the complete Handbook, written by Colleen Beamer. It covers usage on all aspects of Krecipes and also includes many screenshots of Krecipes in action.


Recipes Search

Simply type in the a part of a recipe name and all those recipes are instantly available to view, edit, or print.

If you'd like to fine-tune your search, the advanced search also allows you to search by title as well as any combination of categories, ingredients, preparation time, authors, servings, or instruction text.


Edit Recipes

Using the three input tabs, you will fill in the details of your recipes. On the first tab is the title, authors, categories, preparation time, and yield. On the next you may input ingredients, and on the last is the instructions.

Shopping List

Add recipes to your shopping list. When you are done, Krecipes will list all the ingredients necessary, combining units for you automatically, and give you a list ready to print.


Diet Helper

Plan out your meals for a day, a few days, or even weeks. Give Krecipes information on what you'd like each of your meals to contain, limit the amount of particular nutrient property (fat, energy, etc.), and Krecipes will do the rest.


Advanced Database Management

Krecipes takes full advantage of the power of relational databases. Categories, ingredients, units, etc. are stored as separate identities which are linked to recipes when used. You can rename one of these in one place, and all recipes using that element are automatically updated.

When importing recipes from an external source, you may find many misspellings and strange capitalization. Simply rename these elements in the "Data" panel to correct all your recipes. For example, you may have the categories "Vegtables" and "Vegatables". Rename "Vegtables" to "Vegatables" and the merge feature will put all the recipes under these two categories into the right category.

Contribute

Coding

We welcome anyone with knowledge of C++ to contribute code, but even if you're not a programmer, here's some other ways you can help, see below

Unless specified elsewhere, you can send any contributions to the Krecipes maintainer, J.M. Santamaría. Reporting bugs

You can use the KDE Bug Tracking System to report bugs.


Translating

  • If you want to translate krecipes you should work inside your local KDE translation team. If you are keen you may want to lurk here. Check the current state of Krecipe's translations for your language and, if you feel brave, ask to join a translation team :)
  • User interface: We could always use help translating into as many languages as possible. Note that the current 2.0 branch is not on string freeze, however some translation teams are working in krecipes anyway, so feel free to join your local translation team and work.
  • Handbook: Currently the handbook in english is very outdated, please wait for instructions.
  • Sample recipes: We are figuring out a technical solution and proper workflow to do this, please wait for instructions.


Giving Feedback

Give us your feedback in the Krecipes Forums or in #krecipes IRC channel at FreeNode.

ChangeLog

For access to the ChangeLog with the latest updates available only in SVN, go to this ChangeLog.

Handbook

The handbook is being updated for the KDE 4 port of Krecipes and unfortunately it's not finished yet, you can check it here.

Download

Downloading And Compiling The Latest (2.0-beta2) Release

You can download the latest release or see other releases in the "files" section of the sourceforge page. You can see main changes in this version in the ChangeLog page.

Building The Latest Release Just untar the package first: 

tar -zxf krecipes-[VERSION_NUMBER].tar.gz

And compile 

cmake .
make
make install

Downloading, Building And Installing The Latest Development Version With Git

The project is being developed under extragear/utils in KDE's servers.

To download the source code, do: 

git clone git://anongit.kde.org/krecipes

To update the source code, do: 

cd krecipes
git pull

To build and install it in the default prefix (usually /usr/local): 

mkdir build && cd build
cmake ..
make
make install

To build and install it in other prefix, for instance ~/.kde/: 

mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=~/.kde/
make
make install

Also if you install it in ~/.kde/ you may want to set the following variables in your .bashrc (or wherever it's appropiate for you): 

export PATH=~/.kde/bin:${PATH}
export MANPATH=~/.kde/man:$(manpath)
export KDEDIRS=~/.kde:/usr
export XDG_DATA_DIRS=~/.kde/share:${XDG_DATA_DIRS}
export LD_LIBRARY_PATH=~/.kde/lib

To uninstall it: 

cd build && make uninstall

Contact

Authors

The Old Krecipes Crew

  • Jason Kivlighn
  • Unai Garro
  • Cyril Bosselut
  • Colleen Beamer (who wrote the handbook)


People who worked actively in the KDE 4 port but who are not working in the project at the moment

  • Daniel Sauvé
  • Laurent Montel


The current developers

  • José Manuel Santamaría Lema
  • Martin Engelmann
Retrieved from "https://wikisandbox.kde.org/index.php?title=KRecipes&oldid=339624"