mirror of
https://github.com/YunoHost-Apps/penpot_ynh.git
synced 2024-09-03 19:56:56 +02:00
Merge branch 'master' of https://github.com/orhtej2/penpot_ynh
This commit is contained in:
orhtej2
commit
93c69d8d5a
3 changed files with 98 additions and 160 deletions
133
README.md
133
README.md
|
|
@ -1,85 +1,48 @@
|
||||||
# Packaging an app, starting from this example
|
<!--
|
||||||
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||||
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
|
It shall NOT be edited by hand.
|
||||||
* Edit the `manifest.toml` 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)
|
# Penpot for YunoHost
|
||||||
* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
|
|
||||||
* 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).
|
[](https://dash.yunohost.org/appci/app/penpot)  
|
||||||
* Edit `doc/DISCLAIMER*.md`
|
|
||||||
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
[](https://install-app.yunohost.org/?app=penpot)
|
||||||
|
|
||||||
---
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
<!--
|
|
||||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
> *This package allows you to install Penpot quickly and simply on a YunoHost server.
|
||||||
It shall NOT be edited by hand.
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
-->
|
|
||||||
|
## Overview
|
||||||
# Example app for YunoHost
|
|
||||||
|
Design and prototyping platform meant for cross-domain teams. Non dependent on operating systems, Penpot is web based and works with open standards (SVG). Penpot invites designers all over the world to fall in love with open source while getting developers excited about the design process in return.
|
||||||
[](https://dash.yunohost.org/appci/app/example)  
|
|
||||||
[](https://install-app.yunohost.org/?app=example)
|
**Shipped version:** 1.19.3~ynh1
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
## Screenshots
|
||||||
|
|
||||||
> *This package allows you to install Example app 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.*
|
|
||||||
|
## Documentation and resources
|
||||||
## Overview
|
|
||||||
|
* Official app website: <https://penpot.app/>
|
||||||
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.
|
* Official user documentation: <https://help.penpot.app/user-guide/>
|
||||||
|
* Official admin documentation: <https://help.penpot.app/technical-guide/>
|
||||||
### Features
|
* Upstream app code repository: <https://github.com/penpot/penpot>
|
||||||
|
* YunoHost Store: <https://apps.yunohost.org/app/penpot>
|
||||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
* Report a bug: <https://github.com/YunoHost-Apps/penpot_ynh/issues>
|
||||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
|
||||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
## Developer info
|
||||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
|
||||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/penpot_ynh/tree/testing).
|
||||||
|
|
||||||
|
To try the testing branch, please proceed like that.
|
||||||
**Shipped version:** 1.0~ynh1
|
|
||||||
|
``` bash
|
||||||
**Demo:** https://demo.example.com
|
sudo yunohost app install https://github.com/YunoHost-Apps/penpot_ynh/tree/testing --debug
|
||||||
|
or
|
||||||
## Screenshots
|
sudo yunohost app upgrade penpot -u https://github.com/YunoHost-Apps/penpot_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
||||||
## 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
|
|
||||||
|
|
||||||
* 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>
|
|
||||||
|
|
||||||
## Developer info
|
|
||||||
|
|
||||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_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
|
|
||||||
or
|
|
||||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
|
||||||
|
|
|
||||||
121
README_fr.md
121
README_fr.md
|
|
@ -1,73 +1,48 @@
|
||||||
<!--
|
<!--
|
||||||
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.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Exemple d'app pour YunoHost
|
# Penpot pour YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/example)  
|
[](https://dash.yunohost.org/appci/app/penpot)  
|
||||||
[](https://install-app.yunohost.org/?app=example)
|
|
||||||
|
[](https://install-app.yunohost.org/?app=penpot)
|
||||||
*[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.
|
|
||||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
> *Ce package vous permet d’installer Penpot 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
|
|
||||||
|
## 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.
|
|
||||||
|
Design and prototyping platform meant for cross-domain teams. Non dependent on operating systems, Penpot is web based and works with open standards (SVG). Penpot invites designers all over the world to fall in love with open source while getting developers excited about the design process in return.
|
||||||
### Features
|
|
||||||
|
**Version incluse :** 1.19.3~ynh1
|
||||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
|
||||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
## Captures d’écran
|
||||||
- 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."
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
**Version incluse :** 1.0~ynh1
|
* Site officiel de l’app : <https://penpot.app/>
|
||||||
|
* Documentation officielle utilisateur : <https://help.penpot.app/user-guide/>
|
||||||
**Démo :** https://demo.example.com
|
* Documentation officielle de l’admin : <https://help.penpot.app/technical-guide/>
|
||||||
|
* Dépôt de code officiel de l’app : <https://github.com/penpot/penpot>
|
||||||
## Captures d'écran
|
* YunoHost Store: <https://apps.yunohost.org/app/penpot>
|
||||||
|
* Signaler un bug : <https://github.com/YunoHost-Apps/penpot_ynh/issues>
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
## Avertissements / informations importantes
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/penpot_ynh/tree/testing).
|
||||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
|
||||||
* requiring a full dedicated domain ?
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
* architectures not supported ?
|
|
||||||
* not-working single-sign on or LDAP integration ?
|
``` bash
|
||||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
sudo yunohost app install https://github.com/YunoHost-Apps/penpot_ynh/tree/testing --debug
|
||||||
* etc...
|
ou
|
||||||
|
sudo yunohost app upgrade penpot -u https://github.com/YunoHost-Apps/penpot_ynh/tree/testing --debug
|
||||||
* 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
|
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>
|
||||||
* upgrade process / specificities / things to be aware of ?
|
|
||||||
* security considerations ?
|
|
||||||
|
|
||||||
## 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>
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_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
|
|
||||||
ou
|
|
||||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|
|
||||||
|
|
@ -6,7 +6,7 @@ name = "Penpot"
|
||||||
description.en = "Penpot - The Open-Source design and prototyping platform"
|
description.en = "Penpot - The Open-Source design and prototyping platform"
|
||||||
description.fr = "Penpot - La plateforme de conception et de prototypage open-source"
|
description.fr = "Penpot - La plateforme de conception et de prototypage open-source"
|
||||||
|
|
||||||
version = "1.19.2~ynh1"
|
version = "1.19.3~ynh1"
|
||||||
|
|
||||||
maintainers = ["orhtej2"]
|
maintainers = ["orhtej2"]
|
||||||
|
|
||||||
|
|
@ -136,4 +136,4 @@ ram.runtime = "50M"
|
||||||
extras.yarn.packages = "yarn"
|
extras.yarn.packages = "yarn"
|
||||||
|
|
||||||
[resources.database]
|
[resources.database]
|
||||||
type = "postgresql"
|
type = "postgresql"
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue