1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/dex_ynh.git synced 2024-09-03 18:26:22 +02:00
This commit is contained in:
Limezy 2022-03-23 17:03:16 +07:00
commit f25fe82f52
2 changed files with 32 additions and 43 deletions

View file

@ -1,27 +1,16 @@
# Packaging your an app, starting from this example
- Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
- Edit the `manifest.json` with app specific info.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts, and any relevant conf files in `conf/`.
- Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
- Add a `LICENSE` file for the package.
- Edit `doc/DISCLAIMER*.md`
- The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # Dex for YunoHost
[![Integration level](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) [![Integration level](https://dash.yunohost.org/integration/dex.svg)](https://dash.yunohost.org/appci/app/dex) ![](https://ci-apps.yunohost.org/ci/badges/dex.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dex.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Dex with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dex)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server. > *This package allows you to install Dex 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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## Overview
@ -37,13 +26,14 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Excepteur sint occaecat cupidatat non proident, sunt in culpa."
**Shipped version:** 1.0~ynh1 **Shipped version:** 2.31.1~ynh1
**Demo:** https://demo.example.com
## Screenshots ## Screenshots
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/Dex screenshot.png)
![](./doc/screenshots/.DS_Store)
## Disclaimers / important information ## Disclaimers / important information
@ -62,22 +52,21 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: https://dexidp.io
* Official user documentation: https://yunohost.org/apps * Official admin documentation: https://dexidp.io/docs/
* Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/dexidp/dex
* Upstream app code repository: https://some.forge.com/example/example * YunoHost documentation for this app: https://yunohost.org/app_dex
* YunoHost documentation for this app: https://yunohost.org/app_example * Report a bug: https://github.com/YunoHost-Apps/dex_ynh/issues
* Report a bug: https://github.com/YunoHost-Apps/example_ynh/issues
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/dex_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/dex_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade dex -u https://github.com/YunoHost-Apps/dex_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

View file

@ -1,12 +1,12 @@
# Example app pour YunoHost # Dex pour YunoHost
[![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) [![Niveau d'intégration](https://dash.yunohost.org/integration/dex.svg)](https://dash.yunohost.org/appci/app/dex) ![](https://ci-apps.yunohost.org/ci/badges/dex.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dex.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Dex avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dex)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Dex 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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
@ -22,13 +22,14 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Excepteur sint occaecat cupidatat non proident, sunt in culpa."
**Version incluse :** 1.0~ynh1 **Version incluse :** 2.31.1~ynh1
**Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/Dex screenshot.png)
![](./doc/screenshots/.DS_Store)
## Avertissements / informations importantes ## Avertissements / informations importantes
@ -47,22 +48,21 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://example.com * Site officiel de l'app : https://dexidp.io
* Documentation officielle utilisateur : https://yunohost.org/apps * Documentation officielle de l'admin : https://dexidp.io/docs/
* Documentation officielle de l'admin : https://yunohost.org/packaging_apps * Dépôt de code officiel de l'app : https://github.com/dexidp/dex
* Dépôt de code officiel de l'app : https://some.forge.com/example/example * Documentation YunoHost pour cette app : https://yunohost.org/app_dex
* Documentation YunoHost pour cette app : https://yunohost.org/app_example * Signaler un bug : https://github.com/YunoHost-Apps/dex_ynh/issues
* Signaler un bug : https://github.com/YunoHost-Apps/example_ynh/issues
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/dex_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/dex_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade dex -u https://github.com/YunoHost-Apps/dex_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps