YunoHost-Apps/tooljet_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/tooljet_ynh.git synced 2024-10-01 13:34:55 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
Yunohost-Bot 2022-02-10 00:12:05 +00:00 committed by Yunohost-Bot
parent 244342ba3b
commit db5ca3737b
2 changed files with 62 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,52 +1,52 @@
# Packaging your 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 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 # ToolJet for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/tooljet.svg)](https://dash.yunohost.org/appci/app/tooljet) ![](https://ci-apps.yunohost.org/ci/badges/tooljet.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tooljet.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Install ToolJet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tooljet)
*[Lire ce readme en français.](./README_fr.md)* *[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 ToolJet 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.* 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. ToolJet is an open-source low-code framework to build and deploy internal tools quickly without much effort from the engineering teams. You can connect to your data sources, such as databases (like PostgreSQL, MongoDB, Elasticsearch, etc), API endpoints (ToolJet supports importing OpenAPI spec & OAuth2 authorization), and external services (like Stripe, Slack, Google Sheets, Airtable) and use our pre-built UI widgets to build internal tools.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - *Visual app builder:* 35+ built-in responsive widgets such as Tables, Charts, Lists, Forms, Progressbars, and more.
- Laboris nisi ut aliquip ex ea commodo consequat ; - *20+ data sources:* connect to databases, cloud storages and APIs.
- Duis aute irure dolor in reprehenderit in voluptate ; - *Desktop & mobile*: ;layout widths can be customised to support different screens.
- Velit esse cillum dolore eu fugiat nulla pariatur ; - *Collaborate:* add comments anywhere on the canvas and tag your team members.
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - *Extend with plugins:*: use our [commandline tool](https://www.npmjs.com/package/tooljet) to easily boostrap new connectors.
- *Version control:* every application have different versions with proper release cycle.
- *Run JS code:* ability custom JavaScript snippets
- *Granular access control* on organization-level and app-level.
- *low-code:* write JS code almost anywhere in the builder. For example, the color property of text can be set to `status === 'success' ? 'green' : 'red'`
- *no-code query editors* for all supported data sources.
- *Join and transform data:* transform query results using just JavaScript code.
- *Secure:* All the credentials are securely encrypted using `aes-256-gcm`.
- *Doesn't store data:* ToolJet acts only as a proxy and doesn't store any data.
**Shipped version:** 1.0~ynh1 **Shipped version:** 1.0~ynh1
**Demo:** https://demo.example.com
## Screenshots ## Screenshots
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.png)
## Disclaimers / important information ## Disclaimers / important information
* This app requites a full dedicated domain (or subdomain).
* SSO does *not* work.
* Any known limitations, constrains or stuff not working, such as (but not limited to): * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * requiring a full dedicated domain ?
* architectures not supported ? * architectures not supported ?
@ -62,22 +62,21 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentation and resources ## Documentation and resources
* Official app website: https://example.com * Official app website: https://tooljet.com/
* Official user documentation: https://yunohost.org/apps * Official user documentation: https://docs.tooljet.com/docs/intro
* Official admin documentation: https://yunohost.org/packaging_apps * Upstream app code repository: https://github.com/ToolJet/ToolJet
* Upstream app code repository: https://some.forge.com/example/example * YunoHost documentation for this app: https://yunohost.org/app_tooljet
* YunoHost documentation for this app: https://yunohost.org/app_example * Report a bug: https://github.com/YunoHost-Apps/tooljet_ynh/issues
* Report a bug: https://github.com/YunoHost-Apps/example_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/tooljet_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/tooljet_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 tooljet -u https://github.com/YunoHost-Apps/tooljet_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** https://yunohost.org/packaging_apps

52
README_fr.md
View file

@ -1,37 +1,48 @@
# Example app pour YunoHost # ToolJet pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/tooljet.svg)](https://dash.yunohost.org/appci/app/tooljet) ![](https://ci-apps.yunohost.org/ci/badges/tooljet.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tooljet.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) [![Installer ToolJet avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tooljet)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer ToolJet 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. ToolJet is an open-source low-code framework to build and deploy internal tools quickly without much effort from the engineering teams. You can connect to your data sources, such as databases (like PostgreSQL, MongoDB, Elasticsearch, etc), API endpoints (ToolJet supports importing OpenAPI spec & OAuth2 authorization), and external services (like Stripe, Slack, Google Sheets, Airtable) and use our pre-built UI widgets to build internal tools.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; - *Visual app builder:* 35+ built-in responsive widgets such as Tables, Charts, Lists, Forms, Progressbars, and more.
- Laboris nisi ut aliquip ex ea commodo consequat ; - *20+ data sources:* connect to databases, cloud storages and APIs.
- Duis aute irure dolor in reprehenderit in voluptate ; - *Desktop & mobile*: ;layout widths can be customised to support different screens.
- Velit esse cillum dolore eu fugiat nulla pariatur ; - *Collaborate:* add comments anywhere on the canvas and tag your team members.
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - *Extend with plugins:*: use our [commandline tool](https://www.npmjs.com/package/tooljet) to easily boostrap new connectors.
- *Version control:* every application have different versions with proper release cycle.
- *Run JS code:* ability custom JavaScript snippets
- *Granular access control* on organization-level and app-level.
- *low-code:* write JS code almost anywhere in the builder. For example, the color property of text can be set to `status === 'success' ? 'green' : 'red'`
- *no-code query editors* for all supported data sources.
- *Join and transform data:* transform query results using just JavaScript code.
- *Secure:* All the credentials are securely encrypted using `aes-256-gcm`.
- *Doesn't store data:* ToolJet acts only as a proxy and doesn't store any data.
**Version incluse :** 1.0~ynh1 **Version incluse :** 1.0~ynh1
**Démo :** https://demo.example.com
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/example.jpg) ![](./doc/screenshots/example.png)
## Avertissements / informations importantes ## Avertissements / informations importantes
* This app requites a full dedicated domain (or subdomain).
* SSO does *not* work.
* Any known limitations, constrains or stuff not working, such as (but not limited to): * Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ? * requiring a full dedicated domain ?
* architectures not supported ? * architectures not supported ?
@ -47,22 +58,21 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://example.com * Site officiel de l'app : https://tooljet.com/
* Documentation officielle utilisateur : https://yunohost.org/apps * Documentation officielle utilisateur : https://docs.tooljet.com/docs/intro
* Documentation officielle de l'admin : https://yunohost.org/packaging_apps * Dépôt de code officiel de l'app : https://github.com/ToolJet/ToolJet
* Dépôt de code officiel de l'app : https://some.forge.com/example/example * Documentation YunoHost pour cette app : https://yunohost.org/app_tooljet
* Documentation YunoHost pour cette app : https://yunohost.org/app_example * Signaler un bug : https://github.com/YunoHost-Apps/tooljet_ynh/issues
* Signaler un bug : https://github.com/YunoHost-Apps/example_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/tooljet_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/tooljet_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 tooljet -u https://github.com/YunoHost-Apps/tooljet_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