mirror of
https://github.com/YunoHost-Apps/phpback_ynh.git
synced 2024-09-03 19:56:34 +02:00
Merge branch 'master' of https://github.com/YunoHost-Apps/phpback_ynh
This commit is contained in:
commit
25f4c4444a
2 changed files with 34 additions and 66 deletions
53
README.md
53
README.md
|
@ -1,48 +1,29 @@
|
||||||
|
|
||||||
# Packaging 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
|
# PHPBack 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/phpback.svg)](https://dash.yunohost.org/appci/app/phpback) ![](https://ci-apps.yunohost.org/ci/badges/phpback.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpback.maintain.svg)
|
||||||
[![Install example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
|
[![Install PHPBack with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpback)
|
||||||
|
|
||||||
*[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 quickly and simply on a YunoHost server.
|
> *This package allows you to install PHPBack 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
|
||||||
|
|
||||||
Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)
|
PHPBack is an open source feedback system you can use for your website. It gives your customers a way to communicate their ideas to improve your products. User feedback has proved to be really effective even if you have a community project or a commercial project.
|
||||||
|
|
||||||
**Shipped version:** 1.0~ynh1
|
**Shipped version:** 1.3.2~ynh1
|
||||||
|
|
||||||
**Demo:** https://demo.example.com
|
|
||||||
|
|
||||||
|
**Demo:** https://www.phpback.org/demo/
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
![](./doc/screenshots/slider-item-1.png)
|
||||||
![](./doc/screenshots/example.jpg)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Disclaimers / important information
|
## Disclaimers / important information
|
||||||
|
|
||||||
|
@ -59,26 +40,22 @@ Explain in *a few (10~15) words* the purpose of the app or what it actually does
|
||||||
* upgrade process / specificities / things to be aware of ?
|
* upgrade process / specificities / things to be aware of ?
|
||||||
* security considerations ?
|
* security considerations ?
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official app website: https://example.com
|
* Official app website: https://www.phpback.org/
|
||||||
* Official user documentation: https://yunohost.org/apps
|
* Upstream app code repository: https://github.com/phpback/phpback
|
||||||
* Official admin documentation: https://yunohost.org/packaging_apps
|
* YunoHost documentation for this app: https://yunohost.org/app_phpback
|
||||||
* Upstream app code repository: https://some.forge.com/example/example
|
* Report a bug: https://github.com/YunoHost-Apps/phpback_ynh/issues
|
||||||
* YunoHost documentation for this app: https://yunohost.org/app_example
|
|
||||||
* 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/phpback_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/phpback_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 phpback -u https://github.com/YunoHost-Apps/phpback_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
45
README_fr.md
45
README_fr.md
|
@ -1,30 +1,25 @@
|
||||||
# Example app pour YunoHost
|
# PHPBack 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/phpback.svg)](https://dash.yunohost.org/appci/app/phpback) ![](https://ci-apps.yunohost.org/ci/badges/phpback.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpback.maintain.svg)
|
||||||
[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
|
[![Installer PHPBack avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpback)
|
||||||
|
|
||||||
*[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)*
|
||||||
|
|
||||||
> *This package allows you to install example quickly and simply on a YunoHost server.
|
> *Ce package vous permet d'installer PHPBack rapidement et simplement sur un serveur YunoHost.
|
||||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
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
|
||||||
|
|
||||||
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)
|
PHPBack is an open source feedback system you can use for your website. It gives your customers a way to communicate their ideas to improve your products. User feedback has proved to be really effective even if you have a community project or a commercial project.
|
||||||
|
|
||||||
**Version incluse:** 1.0~ynh1
|
**Version incluse :** 1.3.2~ynh1
|
||||||
|
|
||||||
**Démo:** https://demo.example.com
|
|
||||||
|
|
||||||
|
**Démo :** https://www.phpback.org/demo/
|
||||||
|
|
||||||
## Captures d'écran
|
## Captures d'écran
|
||||||
|
|
||||||
|
![](./doc/screenshots/slider-item-1.png)
|
||||||
![](./doc/screenshots/example.jpg)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Avertissements / informations importantes
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
@ -41,26 +36,22 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o
|
||||||
* upgrade process / specificities / things to be aware of ?
|
* upgrade process / specificities / things to be aware of ?
|
||||||
* security considerations ?
|
* security considerations ?
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site official de l'app : https://example.com
|
* Site officiel de l'app : https://www.phpback.org/
|
||||||
* Documentation officielle utilisateur: https://yunohost.org/apps
|
* Dépôt de code officiel de l'app : https://github.com/phpback/phpback
|
||||||
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_phpback
|
||||||
* Dépôt de code officiel de l'app: https://some.forge.com/example/example
|
* Signaler un bug : https://github.com/YunoHost-Apps/phpback_ynh/issues
|
||||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_example
|
|
||||||
* 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/phpback_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/phpback_ynh/tree/testing --debug
|
||||||
or
|
ou
|
||||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
sudo yunohost app upgrade phpback -u https://github.com/YunoHost-Apps/phpback_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
|
Loading…
Reference in a new issue