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

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-09-30 10:19:07 +00:00
parent 20ce674aa1
commit 843e75ffb2
2 changed files with 74 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -1,85 +1,78 @@
# 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
It shall NOT be edited by hand.
-->
# Example app for YunoHost
# TLDraw 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)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Integration level](https://dash.yunohost.org/integration/tldraw.svg)](https://dash.yunohost.org/appci/app/tldraw) ![Working status](https://ci-apps.yunohost.org/ci/badges/tldraw.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/tldraw.maintain.svg)
[![Install TLDraw with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw)
*[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 TLDraw 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
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.
TLDraw is a tiny little drawing app.
### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
- 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."
- Very clean and nice UX
- Snappy and very low memory footprint on the server
- PWA ready
- Multiplayer mode (iFrame compatible)
**Shipped version:** 1.0~ynh1
**Shipped version:** 1.24.5~ynh2
**Demo:** https://demo.example.com
**Demo:** https://tldraw.com
## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg)
![Screenshot of TLDraw](./doc/screenshots/TLDraw screenshot.png)
## 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...
* TLDraw can't be installed on a subpath, and needs a fully dedicated domain
* 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 ?
* The multiplayer mode requires Liveblocks API keys (Public and Secret)
* You can get some for free at liveblocks.io
* Be **very careful** though, and keep in mind that by doing so, all your multiplayer rooms data will be stored on livestocks.io SaaS servers, and **NOT** on your server
* Multiplayer mode is completely optional and you don't have to use it
* If API keys are not provided, it will be automatically deactivated
* TLDraw will not take a lot of disk or memory space while running.
* **However**, you will need at least 2.5GB of RAM and 5GB of disk space during installation time
* The build can be quite long, be patient !
* TLDraw offers all functionnalities (including multiplayer) for free at tldraw.com
* However, they have restricted the use of multiplayer mode within an iFrame, which could be a problem
* TLDraw Yunohost app is patching that restriction so that you can use multiplayer mode within an iFrame as before
* It could be possible to self-host a multiplayer layer in the future. Some projects have been launched, based on YJS library, such as https://github.com/nimeshnayaju/yjs-tldraw, but sadly none of them is mature enough to be included here.
* Obviously, as soon as multiplayer could be enabled without going through Liveblocks SaaS servers, the app will be updated accordingly
## Documentation and resources
* Official app website: <https://example.com>
* Official user documentation: <https://yunohost.org/apps>
* Official admin documentation: <https://yunohost.org/packaging_apps>
* Upstream app code repository: <https://some.forge.com/example/example>
* YunoHost documentation for this app: <https://yunohost.org/app_example>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
* Official app website: <https://tldraw.com>
* Official user documentation: <https://github.com/tldraw/tldraw/blob/main/guides/documentation.md>
* Official admin documentation: <https://github.com/tldraw/tldraw/blob/main/guides/documentation.md>
* Upstream app code repository: <https://github.com/tldraw/tldraw>
* YunoHost documentation for this app: <https://yunohost.org/app_tldraw>
* Report a bug: <https://github.com/YunoHost-Apps/tldraw_ynh/issues>
## 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/tldraw_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug
or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

70
README_fr.md
View file

@ -3,72 +3,76 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand.
-->
# Example app pour YunoHost
# TLDraw 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)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Niveau d'intégration](https://dash.yunohost.org/integration/tldraw.svg)](https://dash.yunohost.org/appci/app/tldraw) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/tldraw.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/tldraw.maintain.svg)
[![Installer TLDraw avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tldraw)
*[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 TLDraw 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
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.
TLDraw is a tiny little drawing app.
### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
- 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."
- Very clean and nice UX
- Snappy and very low memory footprint on the server
- PWA ready
- Multiplayer mode (iFrame compatible)
**Version incluse :** 1.0~ynh1
**Version incluse :** 1.24.5~ynh2
**Démo :** https://demo.example.com
**Démo :** https://tldraw.com
## Captures d'écran
![Capture d'écran de Example app](./doc/screenshots/example.jpg)
![Capture d'écran de TLDraw](./doc/screenshots/TLDraw screenshot.png)
## 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...
* TLDraw can't be installed on a subpath, and needs a fully dedicated domain
* 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 ?
* The multiplayer mode requires Liveblocks API keys (Public and Secret)
* You can get some for free at liveblocks.io
* Be **very careful** though, and keep in mind that by doing so, all your multiplayer rooms data will be stored on livestocks.io SaaS servers, and **NOT** on your server
* Multiplayer mode is completely optional and you don't have to use it
* If API keys are not provided, it will be automatically deactivated
* TLDraw will not take a lot of disk or memory space while running.
* **However**, you will need at least 2.5GB of RAM and 5GB of disk space during installation time
* The build can be quite long, be patient !
* TLDraw offers all functionnalities (including multiplayer) for free at tldraw.com
* However, they have restricted the use of multiplayer mode within an iFrame, which could be a problem
* TLDraw Yunohost app is patching that restriction so that you can use multiplayer mode within an iFrame as before
* It could be possible to self-host a multiplayer layer in the future. Some projects have been launched, based on YJS library, such as https://github.com/nimeshnayaju/yjs-tldraw, but sadly none of them is mature enough to be included here.
* Obviously, as soon as multiplayer could be enabled without going through Liveblocks SaaS servers, the app will be updated accordingly
## Documentations et ressources
* Site officiel de l'app : <https://example.com>
* Documentation officielle utilisateur : <https://yunohost.org/apps>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
* Site officiel de l'app : <https://tldraw.com>
* Documentation officielle utilisateur : <https://github.com/tldraw/tldraw/blob/main/guides/documentation.md>
* Documentation officielle de l'admin : <https://github.com/tldraw/tldraw/blob/main/guides/documentation.md>
* Dépôt de code officiel de l'app : <https://github.com/tldraw/tldraw>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_tldraw>
* Signaler un bug : <https://github.com/YunoHost-Apps/tldraw_ynh/issues>
## 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/tldraw_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug
ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
sudo yunohost app upgrade tldraw -u https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>