mirror of
https://github.com/YunoHost-Apps/tandoor_ynh.git
synced 2024-09-03 20:35:56 +02:00
77 lines
3.4 KiB
Markdown
77 lines
3.4 KiB
Markdown
<!--
|
||
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
||
It shall NOT be edited by hand.
|
||
-->
|
||
|
||
# Tandoor for YunoHost
|
||
|
||
[](https://ci-apps.yunohost.org/ci/apps/tandoor/)  
|
||
|
||
[](https://install-app.yunohost.org/?app=tandoor)
|
||
|
||
*[Read this README in other languages.](./ALL_README.md)*
|
||
|
||
> *This package allows you to install Tandoor quickly and simply on a YunoHost server.*
|
||
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
||
|
||
## Overview
|
||
|
||
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.
|
||
|
||
### Core Features
|
||
|
||
- 🥗 **Manage your recipes** - Manage your ever growing recipe collection
|
||
- 📆 **Plan** - multiple meals for each day
|
||
- 🛒 **Shopping lists** - 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](https://docs.djangoproject.com/en/3.0/ref/contrib/postgres/search/#trigram-similarity)
|
||
- 🏷️ 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](https://schema.org/Recipe)
|
||
- ➗ Support for **fractions** or decimals
|
||
- 🎨 Customize your interface with **themes**
|
||
- 📦 **Sync** files with Dropbox and Nextcloud
|
||
|
||
### All the must haves
|
||
|
||
- 📱Optimized for use on **mobile** devices
|
||
- 🌍 localized in many languages thanks to the awesome community
|
||
- 📥️ **Import your collection** from many other [recipe managers](https://docs.tandoor.dev/features/import_export/)
|
||
- ➕ Many more like recipe scaling, image compression, printing views and supermarkets
|
||
|
||
**Shipped version:** 1.5.18~ynh1
|
||
|
||
**Demo:** <https://app.tandoor.dev/accounts/login/?demo>
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
## Documentation and resources
|
||
|
||
- Official app website: <https://tandoor.dev>
|
||
- Official user documentation: <https://docs.tandoor.dev>
|
||
- Official admin documentation: <https://docs.tandoor.dev>
|
||
- Upstream app code repository: <https://github.com/TandoorRecipes/recipes>
|
||
- YunoHost Store: <https://apps.yunohost.org/app/tandoor>
|
||
- Report a bug: <https://github.com/YunoHost-Apps/tandoor_ynh/issues>
|
||
|
||
## Developer info
|
||
|
||
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/tandoor_ynh/tree/testing).
|
||
|
||
To try the `testing` branch, please proceed like that:
|
||
|
||
```bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/tandoor_ynh/tree/testing --debug
|
||
or
|
||
sudo yunohost app upgrade tandoor -u https://github.com/YunoHost-Apps/tandoor_ynh/tree/testing --debug
|
||
```
|
||
|
||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|