diff --git a/README.md b/README.md index de98686..78ad5a0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ -# OpenProject App for YunoHost + -[![Invtegration level](https://dash.yunohost.org/integration/Openproject.svg)](https://dash.yunohost.org/appci/app/Openproject) -[![Install Openproject with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=Openproject) +# OpenProject for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/openproject.svg)](https://dash.yunohost.org/appci/app/openproject) ![](https://ci-apps.yunohost.org/ci/badges/openproject.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/openproject.maintain.svg) +[![Install OpenProject with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=openproject) *[Lire ce readme en français.](./README_fr.md)* -
- -
+> *This package allows you to install OpenProject 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.* -*This package allow you to install Openproject quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +## Overview ## Overview OpenProject is a web-based project management software. Its key features are: @@ -25,44 +28,35 @@ OpenProject is a web-based project management software. Its key features are: - Forums - Meeting agendas and meeting minutes -**Shipped version:** 10.0 + +**Shipped version:** 10.5.1~ynh1 + + ## Screenshots -![GANTT-Chart displayed y the App.](https://www.openproject.org/wp-content/uploads/2018/09/Gantt-chart.jpg) +![](./doc/screenshots/screenshot1.png) -## Configuration +## Disclaimers / important information -After installation, every change can be made directly in the web application. +* default user and password is admin / admin +## Documentation and resources -## Documentation +* Official app website: https://www.openproject.org/ +* Official admin documentation: https://www.openproject.org/docs/ +* Upstream app code repository: https://github.com/opf/openproject +* YunoHost documentation for this app: https://yunohost.org/app_openproject +* Report a bug: https://github.com/YunoHost-Apps/openproject_ynh/issues -- [Official documentation here](https://github.com/opf/openproject/tree/stable/10). -- YunoHost documentation: If specific documentation is needed, feel free to contribute! +## Developer info -## YunoHost specific features +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/openproject_ynh/tree/testing). -#### Multi-users support +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/openproject_ynh/tree/testing --debug +or +sudo yunohost app upgrade openproject -u https://github.com/YunoHost-Apps/openproject_ynh/tree/testing --debug +``` -LDAP is not embedded yet, neither HTTP authentication support. - -#### Supported architectures - -- x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/Openproject%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/Openproject/) -- ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/Openproject%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/Openproject/) -- Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/Openproject%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/Openproject/) - -## Limitations - -- No known limitations :) - -## License - -This repository is under the GNU AGPL licence v3. Please see [the license file](./LICENSE) for more information. - -## Links - -- Report a bug: https://github.com/YunoHost-Apps/Openproject_ynh/issues -- App website: https://www.openproject.org/ -- Upstream app repository: https://github.com/opf/openproject -- YunoHost website: https://yunohost.org/ +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 9025174..8fe0162 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,68 +1,58 @@ # OpenProject pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/Openproject.svg)](https://dash.yunohost.org/appci/app/Openproject) -[![Installer Openproject avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=Openproject) +[![Niveau d'intégration](https://dash.yunohost.org/integration/openproject.svg)](https://dash.yunohost.org/appci/app/openproject) ![](https://ci-apps.yunohost.org/ci/badges/openproject.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/openproject.maintain.svg) +[![Installer OpenProject avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=openproject) -*[Read this readme in English.](./ README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -- -
- -Ce dépôt vous permet d'installer Openproject rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, veuillez consulter [ici] (https://yunohost.org/#/install) pour savoir comment l'installer et en profiter. +> *Ce package vous permet d'installer OpenProject 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 -OpenProject est un logiciel de gestion de projet entièrement en Web. Ses principales caractéristiques sont : -- Planification et ordonnancement de projets, -- Feuille de route du produit et planification des versions, -- Gestion des tâches et collaboration au sein des équipes, -- Agile et Scrum, -- Suivi du temps, reporting des coûts et budgétisation, -- Suivi des bogues, -- Wikis, -- Forums, -- Ordres du jour et comptes rendus, +## Overview +OpenProject is a web-based project management software. Its key features are: + +- Project planning and scheduling +- Product roadmap and release planning +- Task management and team collaboration +- Agile and Scrum +- Time tracking, cost reporting and budgeting +- Bug tracking +- Wikis +- Forums +- Meeting agendas and meeting minutes + + +**Version incluse :** 10.5.1~ynh1 + -** Version incluse : ** 10.0 ## Captures d'écran -![GANTT-Chart affiché dans l'application.](https://www.openproject.org/wp-content/uploads/2018/09/Gantt-chart.jpg) +![](./doc/screenshots/screenshot1.png) -## Configuration +## Avertissements / informations importantes -Après l'installation, chaque modification peut être effectuée directement dans la page d'admin Web. +* default user and password is admin / admin +## Documentations et ressources -## Documentation +* Site officiel de l'app : https://www.openproject.org/ +* Documentation officielle de l'admin : https://www.openproject.org/docs/ +* Dépôt de code officiel de l'app : https://github.com/opf/openproject +* Documentation YunoHost pour cette app : https://yunohost.org/app_openproject +* Signaler un bug : https://github.com/YunoHost-Apps/openproject_ynh/issues - * [Documentation officielle ici](https://github.com/opf/openproject/tree/stable/10) - * Documentation YunoHost: Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. +## Informations pour les développeurs -#### Support multi-utilisateurs +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/openproject_ynh/tree/testing). -LDAP n'est pas encore intégré, ni le support de l'authentification HTTP. - -#### Architectures supportées - -* x86-64b - [![Statut du _build_](https://ci-apps.yunohost.org/ci/logs/Openproject%20%28Apps%29.svg)](https: //ci-apps.yunohost. org / ci / apps / Openproject /) -* ARMv8-A - [![Statut du _build_](https://ci-apps-arm.yunohost.org/ci/logs/Openproject%20%28Apps%29.svg)](https: // ci-apps- arm.yunohost.org/ci/apps/Openproject/) -* Jessie x86-64b - [![Statut du _build_](https://ci-stretch.nohost.me/ci/logs/Openproject%20%28Apps%29.svg)](https: //ci-stretch.nohost .me / ci / apps / Openproject /) - -## Limitations - -* Aucune limitation connue :) - - -## Licence - -Ce dépôt et son code sont sous la licence GNU AGPL v3. Vous pouvez consulter [le fichier de licence](./LICENSE) pour plus d'informations. - -## Liens - - * Signaler un bug: https://github.com/YunoHost-Apps/Openproject_ynh/issues - * Site Web de l'application: https://www.openproject.org/ - * Référentiel d'applications en amont: https://github.com/opf/openproject - * Site Web YunoHost: https://yunohost.org/ +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/openproject_ynh/tree/testing --debug +ou +sudo yunohost app upgrade openproject -u https://github.com/YunoHost-Apps/openproject_ynh/tree/testing --debug +``` +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file