csillag61/recipes

Django application for managing recipes

Recipes

Recipes is a Django application to manage, tag and search recipes using either built in models or external storage providers hosting PDF's, Images or other files.

More Screenshots

Features

• 📦 Sync files with Dropbox and Nextcloud (more can easily be added)
• 🔍 Powerful search with Djangos TrigramSimilarity
• 🏷️ Create and search for tags, assign them in batch to all files matching certain filters
• 📄 Create recipes locally within a nice, standardized web interface
• ⬇️ Import recipes from thousands of websites supporting ld+json or microdata
• 📱 Optimized for use on mobile devices like phones and tablets
• 🛒 Generate shopping lists from recipes
• 📆 Create a Plan on what to eat when
• 👪 Share recipes with friends and comment on them to suggest or remember changes you made
• ➗ automatically convert decimal units to fractions for those who like this
• 🐳 Easy setup with Docker
• 🎨 Customize your interface with themes
• ✉️ Export and import recipes from other users
• 🌍 localized in many languages thanks to the awesome community
• ➕ Many more like recipe scaling, image compression, cookbooks, printing views, ...

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. Some Documentation can be found here

While this application has been around for a while and is actively used by many (including myself) it is still considered beta software that has a lot of rough edges and unpolished parts.

Installation

The docker image (vabene1111/recipes) simply exposes the application on port 8080. You may choose any preferred installation method, the following are just examples to make it easier.

I will try to support issues with any kind of installation but since I run the docker setup I can only offer limited help for other methods.

Docker-Compose [Recommended]

1. Choose one of the included configurations here.
2. Download the environment (config) file template and fill it out wget https://raw.githubusercontent.com/vabene1111/recipes/develop/.env.template -O .env
3. Start the container docker-compose up -d
4. Open the page to create the first user.

Manual

Python >= 3.8 is required to run this! Refer to manual install for detailed instructions.

Kubernetes

You can find a basic kubernetes setup here. Please see the README in the folder for more detail.

Updating

While intermediate updates can be skipped when updating please make sure to read the release notes in case some special action is required to update.

0. Before updating it is recommended to create a backup!
1. Stop the container using docker-compose down
2. Pull the latest image using docker-compose pull
3. Start the container again using docker-compose up -d

Contributing

Pull Requests and ideas are welcome, feel free to contribute in any way.

If you want feel free to open an issue or pull request to add yourself to the list of awesome contributors.

Getting Started

This application is developed using the django framework for Python. They have excellent documentation on how to get started, so I will only give you the basics here

1. Clone this repository wherever you like and install the Python language for your OS (at least version 3.8)
2. Open it in your favorite editor/IDE (e.g. PyCharm)
   1. if you want, create a virutal environment for all your packages.
3. Install all required packages by running pip install -r requirements.txt
4. Run the migrations python manage.py migrate
5. Start the development server python manage.py runserver

There is no need to set any environment variables. By default, a simple sqlite database is used and all settings are populated from default values.

Translating

There is a transifex project project to enable community driven translations. If you want to contribute a new language or help maintain an already existing one feel free to create a transifex account (using the link above) and request to join the project.

It is also possible to provide the translations directly by creating a new language using manage.py makemessages -l <language_code> -i venv. Once finished simply open a PR with the changed files.

License

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

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 payed 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 trough 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).