2021-05-10 17:52:42 +02:00
# Example app pour YunoHost
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
[![Niveau d'intégration ](https://dash.yunohost.org/integration/example.svg )](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg)
[![Installer example avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=example)
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
> *This package allows you to install example 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.*
2019-01-28 00:21:25 +01:00
## Vue d'ensemble
2021-05-10 17:52:42 +02:00
Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
**Version incluse:** 1.0~ynh1
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
**Démo:** https://demo.example.com
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
## Captures d'écran
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
![](./doc/screenshots/example.jpg)
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
## Avertissements / informations importantes
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
* 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...
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
* 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 ?
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
## Documentations et ressources
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
* Site official de l'app : https://example.com
* Documentation officielle utilisateur: https://yunohost.org/apps
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
* Dépôt de code officiel de l'app: https://some.forge.com/example/example
* Documentation YunoHost pour cette app: https://yunohost.org/app_example
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
2019-01-28 00:21:25 +01:00
2020-08-02 15:41:28 +02:00
## Informations pour les développeurs
2019-01-28 00:21:25 +01:00
2021-05-10 17:52:42 +02:00
Merci de faire vos pull request sur la [branche testing ](https://github.com/YunoHost-Apps/example_ynh/tree/testing ).
2019-01-28 00:21:25 +01:00
Pour essayer la branche testing, procédez comme suit.
```
2021-05-10 17:52:42 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
2019-01-28 00:21:25 +01:00
```
2021-05-10 17:52:42 +02:00
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps