mirror of https://github.com/YunoHost-Apps/tldraw_ynh.git synced 2024-09-03 20:35:54 +02:00

A tiny little drawing app

closember

Find a file

Limezy a2a880d0b7 Merge branch 'master' into testing		2022-09-30 19:08:42 +07:00
.github	Initial commit	2022-09-27 15:54:46 +07:00
conf	Should work	2022-09-30 12:15:43 +07:00
doc	Update DISCLAIMER.md	2022-09-30 11:30:33 +02:00
scripts	Linter	2022-09-30 15:09:39 +07:00
sources	Test	2022-09-29 20:36:34 +07:00
.gitignore	Initial commit	2022-09-27 15:54:46 +07:00
check_process	Update check_process	2022-09-30 13:06:08 +07:00
config_panel.toml.example	Initial commit	2022-09-27 15:54:46 +07:00
LICENSE	Doc & info	2022-09-29 00:34:16 +07:00
manifest.json	Update manifest.json	2022-09-30 16:45:44 +07:00
README.md	Auto-update README	2022-09-30 10:18:20 +00:00
README_fr.md	Auto-update README	2022-09-30 10:18:20 +00:00

README.md

TLDraw for YunoHost

Lire ce readme en français.

This package allows you to install TLDraw quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

TLDraw is a tiny little drawing app.

Features

Very clean and nice UX
Snappy and very low memory footprint on the server
PWA ready
Multiplayer mode (iFrame compatible)

Shipped version: 1.24.5~ynh2

Demo: https://tldraw.com

Screenshots

![Screenshot of TLDraw](./doc/screenshots/TLDraw screenshot.png)

Disclaimers / important information

TLDraw can't be installed on a subpath, and needs a fully dedicated domain
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://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.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/tldraw_ynh/tree/testing --debug
or
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