mirror of
https://github.com/YunoHost-Apps/tandoor_ynh.git
synced 2024-09-03 20:35:56 +02:00
96 lines
4.5 KiB
Markdown
96 lines
4.5 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 pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/tandoor)  
|
||
[](https://install-app.yunohost.org/?app=tandoor)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Tandoor rapidement et simplement sur un serveur YunoHost.
|
||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||
|
||
## Vue d'ensemble
|
||
|
||
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
|
||
|
||
**Version incluse :** 1.3.3~ynh1
|
||
|
||
**Démo :** https://app.tandoor.dev/accounts/login/?demo
|
||
|
||
## Captures d'écran
|
||
|
||
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||
* requiring a full dedicated domain ?
|
||
* architectures not supported ?
|
||
* not-working single-sign on or LDAP integration ?
|
||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||
* etc...
|
||
|
||
* Other infos that people should be aware of, such as:
|
||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||
* how to configure / administrate the application if it ain't obvious
|
||
* upgrade process / specificities / things to be aware of ?
|
||
* security considerations ?
|
||
|
||
* Known limitations:
|
||
* Requires a full dedicated domain for now
|
||
|
||
* Specific Steps
|
||
* The first time the app is installed, you need to setup the initial super user. If you directly login with your YunoHost user's credentials, you will not be able to create the superuser from the web interface.
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l'app : <https://tandoor.dev>
|
||
* Documentation officielle utilisateur : <https://docs.tandoor.dev>
|
||
* Documentation officielle de l'admin : <https://docs.tandoor.dev>
|
||
* Dépôt de code officiel de l'app : <https://github.com/TandoorRecipes/recipes>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_tandoor>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/tandoor_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/tandoor_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/tandoor_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade tandoor -u https://github.com/YunoHost-Apps/tandoor_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|