Skip to content

Latest commit

 

History

History
87 lines (65 loc) · 6.14 KB

README.md

File metadata and controls

87 lines (65 loc) · 6.14 KB



Tandoor Recipes - Advanced

Improvements over the vanilla Tandoor Recipes:

This is my personal fork of Tandoor Recipes. It includes serveral features I've written that where not or not yet accepted as pull requests upstream.

You can also find my app icon Android app for a shopping list (Source Code).

Timeline: A stable release of both is planned after the (February 2022?) Release of the upstream Tandoor Recipes with the "Shopping List V2" feature.


The recipe manager that allows you to manage your ever growing collection of digital recipes.

Installation

  • How to set up the software
  • Docker Image provided by Eric Trösch
  • How to set up a development environment
  • first step: After setting up your user, go to the "+" sign on the top, choose "import recipe" and drag the "bookmark this" into your bookmark bar/list. Then visit any recipe website, choose a recipe you like, click the bookmark and allow popups to easily start populating your personal recipe collection.

Core Features

  • 🥗 Manage your recipes - Manage your ever growing recipe collection
  • 📆 Plan - multiple meals for each day
  • 🛒 Shopping lists V2 - via the meal plan or straight from recipes
  • 📚 Cookbooks - collect recipes into books
  • 👪 Share and collaborate on recipes with friends and family

Made by and for power users

  • 🔍 Powerful & customizable search with fulltext support and TrigramSimilarity
  • 🏷️ Create and search for tags, assign them in batch to all files matching certain filters
  • ↔️ Quickly merge and rename ingredients, tags and units
  • 📥️ Import recipes from thousands of websites supporting ld+json or microdata
  • ➗ Support for fractions or decimals
  • 🐳 Easy setup with Docker and included examples for Kubernetes, Unraid and Synology
  • 🎨 Customize your interface with themes
  • 📦 Sync files with Dropbox and Nextcloud

All the must haves

  • 📱Optimized for use on mobile devices and also a companion native Android app
  • 🌍 localized in many languages thanks to the awesome community
  • 📥️ Import your collection from many other recipe managers including special Cookidoo importer for your personal, non-public receipt list
  • ➕ Many more like recipe scaling, image compression, printing views and supermarkets

This application is meant for people with a collection of recipes they want to share with family and friends or simply store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as a public page.

Contributing

You can help out with the ongoing development by looking for potential bugs in our code base, or by contributing new features. We are always welcoming new pull requests containing bug fixes, refactors and new features. We have a list of tasks and bugs on our issue tracker on Github. Please comment on issues if you want to contribute with, to avoid duplicating effort.

License

Beginning with version 0.10.0 the code in this repository is licensed under the GNU AGPL v3 license with a common clause selling exception. See LICENSE.md for details.

NOTE: There appears to be a whole range of legal issues with licensing anything else then the standard completely open licenses. I am in the process of getting some professional legal advice to sort out these issues. Please also see Issue 238 for some discussion and reasoning regarding the topic.

Reasoning
This software and all its features are and will always be free for everyone to use and enjoy.

The reason for the selling exception is that a significant amount of time was spend over multiple years to develop this software. A paid hosted version which will be identical in features and code base to the software offered in this repository will likely be released in the future (including all features needed to sell a hosted version as they might also be useful for personal use). This will not only benefit me personally but also everyone who self-hosts this software as any profits made through selling the hosted option allow me to spend more time developing and improving the software for everyone. Selling exceptions are approved by Richard Stallman and the common clause license is very permissive (see the FAQ).