YunoHost-Apps/pytition_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pytition_ynh.git synced 2024-09-03 20:16:08 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-04-05 14:08:19 +00:00
parent c90bb7f46d
commit 424241e3d5
2 changed files with 46 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
README.md
View file

@ -1,83 +1,58 @@
# 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 # Pytition 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/pytition.svg)](https://dash.yunohost.org/appci/app/pytition) ![](https://ci-apps.yunohost.org/ci/badges/pytition.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pytition.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install Pytition with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pytition)
*[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 Pytition 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
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pytition is an application for privacy-friendly online petitions you can host on your own server.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Host petitions without compromising the privacy of your signatories.
- Laboris nisi ut aliquip ex ea commodo consequat ; - No tracking, ever: CSS, JS and all resources are self-hosted. Pytition does not use CDN.
- Duis aute irure dolor in reprehenderit in voluptate ; - Responsive UI: works well on phones/tablets/laptops/desktops.
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Multi-lingual UI with i18n: English, French, Italian, Occitan, Spanish.
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - You can pre-visualize petitions before publishing them.
- Easy to use: petition content is typed-in via TinyMCE editors (like WordPress).
- You can export signatures in CSV format.
**Shipped version:** 1.0~ynh1 **Shipped version:** 2.4~ynh1
**Demo:** https://demo.example.com **Demo:** https://demo.pytition.org
## Screenshots
![](./doc/screenshots/example.jpg)
## Disclaimers / important information ## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to): * No Single-Sign-On and Yunohost LDAP support
* 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 ?
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: https://github.com/pytition/Pytition
* Official user documentation: https://yunohost.org/apps * Official admin documentation: https://pytition.readthedocs.io/en/latest/
* Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/pytition/Pytition
* Upstream app code repository: https://some.forge.com/example/example * YunoHost documentation for this app: https://yunohost.org/app_pytition
* YunoHost documentation for this app: https://yunohost.org/app_example * Report a bug: https://github.com/YunoHost-Apps/pytition_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/pytition_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/pytition_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 pytition -u https://github.com/YunoHost-Apps/pytition_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

60
README_fr.md
View file

@ -1,68 +1,54 @@
# Example app pour YunoHost # Pytition 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/pytition.svg)](https://dash.yunohost.org/appci/app/pytition) ![](https://ci-apps.yunohost.org/ci/badges/pytition.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pytition.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer Pytition avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pytition)
*[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 Pytition 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
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Pytition permet d'héberger des pétitions respectueuses de la vie privée sur votre propre serveur.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - Hébergez des pétitions sans compromettre l'identité de vos signataires
- Laboris nisi ut aliquip ex ea commodo consequat ; - Pas de tracking : CSS, JS et autres ressources sont auto-hébergées. Pas d'usage de CDN.
- Duis aute irure dolor in reprehenderit in voluptate ; - Interface réactive : fonctione sur smartphones et tablettes autant que sur ordinateur.
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Interface traduite : anglais, français, italien, occitan, espagnol.
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - Vous pouvez prévisualiser les pétitions avant publication.
- Simple à utiliser grâce à des éditeurs TinyMCE (comme Wordpress)
- Vous pouvez exporter les signatures via CSV.
**Version incluse :** 1.0~ynh1 **Version incluse :** 2.4~ynh1
**Démo :** https://demo.example.com **Démo :** https://demo.pytition.org
## Captures d'écran
![](./doc/screenshots/example.jpg)
## Avertissements / informations importantes ## Avertissements / informations importantes
* Any known limitations, constrains or stuff not working, such as (but not limited to): * Pas de support du Single-Sign-On ou du LDAP Yunohost.
* 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 ?
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://example.com * Site officiel de l'app : https://github.com/pytition/Pytition
* Documentation officielle utilisateur : https://yunohost.org/apps * Documentation officielle de l'admin : https://pytition.readthedocs.io/en/latest/
* Documentation officielle de l'admin : https://yunohost.org/packaging_apps * Dépôt de code officiel de l'app : https://github.com/pytition/Pytition
* Dépôt de code officiel de l'app : https://some.forge.com/example/example * Documentation YunoHost pour cette app : https://yunohost.org/app_pytition
* Documentation YunoHost pour cette app : https://yunohost.org/app_example * Signaler un bug : https://github.com/YunoHost-Apps/pytition_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/pytition_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/pytition_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 pytition -u https://github.com/YunoHost-Apps/pytition_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