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

65 lines
2.5 KiB
Markdown
Raw Normal View History

2023-10-08 12:42:59 +02:00
<!--
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.
-->
2023-11-17 15:07:58 +01:00
# Grist for YunoHost
[![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)
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
[![Install Grist with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grist)
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
> *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.*
2023-10-08 12:42:59 +02:00
## Overview
2023-11-17 15:07:58 +01:00
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.
2023-10-08 12:42:59 +02:00
### Features
2023-11-17 15:07:58 +01:00
Grist is a hybrid database/spreadsheet, meaning that:
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
- 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.
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
More about the features can be found here: <https://github.com/gristlabs/grist-core/#features>
2023-10-08 12:42:59 +02:00
2023-11-21 22:41:52 +01:00
### Limitations
- You cannot log out from Grist, you have to log out from Yunohost to do that;
2023-10-08 12:42:59 +02:00
2023-12-02 05:16:19 +01:00
**Shipped version:** 1.1.9~ynh1
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
**Demo:** https://docs.getgrist.com
2023-11-17 15:07:58 +01:00
## Screenshots
2023-10-08 12:42:59 +02:00
2023-11-17 15:07:58 +01:00
![Screenshot of Grist](./doc/screenshots/grist.jpg)
2023-10-08 12:42:59 +02:00
## Documentation and resources
2023-11-17 15:07:58 +01:00
* Official app website: <https://getgrist.com>
* Official user documentation: <https://support.getgrist.com/>
* Official admin documentation: <https://www.getgrist.com/product/self-managed/>
* Upstream app code repository: <https://github.com/gristlabs/grist-core/>
* YunoHost Store: <https://apps.yunohost.org/app/grist>
* Report a bug: <https://github.com/YunoHost-Apps/grist_ynh/issues>
2023-10-08 12:42:59 +02:00
## Developer info
2023-11-17 15:07:58 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/grist_ynh/tree/testing).
2023-10-08 12:42:59 +02:00
To try the testing branch, please proceed like that.
2023-11-17 15:07:58 +01:00
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/grist_ynh/tree/testing --debug
2023-10-08 12:42:59 +02:00
or
2023-11-17 15:07:58 +01:00
sudo yunohost app upgrade grist -u https://github.com/YunoHost-Apps/grist_ynh/tree/testing --debug
2023-10-08 12:42:59 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>