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

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2023-11-17 14:07:58 +00:00
parent 960244afc5
commit b5ad6f3537
2 changed files with 57 additions and 96 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
README.md
View file

@ -1,86 +1,60 @@
# Packaging an app, starting from this example
- [DONE] Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
- [DONE] Edit the `manifest.toml` with app specific info.
- [DONE] 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)
- [DONE] Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
- [DONE] Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
- 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 # Grist for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/grist.svg)](https://dash.yunohost.org/appci/app/grist) ![Working status](https://ci-apps.yunohost.org/ci/badges/grist.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/grist.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
_[Lire ce readme en français.](./README_fr.md)_ [![Install Grist with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grist)
> _This package allows you to install Example app quickly and simply on a YunoHost server. *[Lire ce readme en français.](./README_fr.md)*
> If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it._
> *This package allows you to install Grist 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.*
## 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. Grist is a modern relational spreadsheet. It combines the flexibility of a spreadsheet with the robustness of a database to organize your data and make you more productive.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; Grist is a hybrid database/spreadsheet, meaning that:
- Laboris nisi ut aliquip ex ea commodo consequat ;
- Duis aute irure dolor in reprehenderit in voluptate ;
- Velit esse cillum dolore eu fugiat nulla pariatur ;
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
**Shipped version:** 1.0~ynh1 - Columns work like they do in databases: they are named, and they hold one kind of data.
- Columns can be filled by formula, spreadsheet-style, with automatic updates when referenced cells change.
**Demo:** https://demo.example.com More about the features can be found here: <https://github.com/gristlabs/grist-core/#features>
**Shipped version:** 1.1.5~ynh2
**Demo:** https://docs.getgrist.com
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Grist](./doc/screenshots/grist.jpg)
## Disclaimers / important information
- 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...
- 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://getgrist.com>
- Official user documentation: <https://yunohost.org/apps> * Official user documentation: <https://support.getgrist.com/>
- Official admin documentation: <https://yunohost.org/packaging_apps> * Official admin documentation: <https://www.getgrist.com/product/self-managed/>
- Upstream app code repository: <https://some.forge.com/example/example> * Upstream app code repository: <https://github.com/gristlabs/grist-core/>
- YunoHost documentation for this app: <https://yunohost.org/app_example> * YunoHost Store: <https://apps.yunohost.org/app/grist>
- Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues> * Report a bug: <https://github.com/YunoHost-Apps/grist_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/grist_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/grist_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 grist -u https://github.com/YunoHost-Apps/grist_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

71
README_fr.md
View file

@ -3,71 +3,58 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Exemple d'app pour YunoHost # Grist pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d’intégration](https://dash.yunohost.org/integration/grist.svg)](https://dash.yunohost.org/appci/app/grist) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/grist.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/grist.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Installer Grist avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grist)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer Grist 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. Grist est un tableur relationel moderne. Il combine la flexibilité d'un tableur avec la robustesse d'une base de données pour organiser vos données et vous rendre plus productif/ve.
### Features ### Fonctionnalités
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; Grist est une solution hybridant la base de données et le tableur, ce qui signifie :
- Laboris nisi ut aliquip ex ea commodo consequat ;
- Duis aute irure dolor in reprehenderit in voluptate ; - Que les colonnes fonctionnent comme dans les bases de données: elles sont nommées, et elle ne peuvent accueillir qu'un seul type de données.
- Velit esse cillum dolore eu fugiat nulla pariatur ; - Que les colonnes peuvent être remplies à l'aide de formules, similaires à celles des tableurs, avec une mise à jour automatique quand les cellules référencées sont modifiées.
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
Plus d'information sur les fonctionnalités sont disponibles ici : <https://github.com/gristlabs/grist-core/#features>
**Version incluse :** 1.0~ynh1 **Version incluse :** 1.1.5~ynh2
**Démo :** https://demo.example.com **Démo :** https://docs.getgrist.com
## Captures d'écran ## Captures d’écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg) ![Capture d’écran de Grist](./doc/screenshots/grist.jpg)
## Avertissements / informations importantes
* 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...
* 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://getgrist.com>
* Documentation officielle utilisateur : <https://yunohost.org/apps> * Documentation officielle utilisateur : <https://support.getgrist.com/>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> * Documentation officielle de l’admin : <https://www.getgrist.com/product/self-managed/>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> * Dépôt de code officiel de l’app : <https://github.com/gristlabs/grist-core/>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example> * YunoHost Store: <https://apps.yunohost.org/app/grist>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues> * Signaler un bug : <https://github.com/YunoHost-Apps/grist_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/grist_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/grist_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 grist -u https://github.com/YunoHost-Apps/grist_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>