YunoHost-Apps/digiscreen_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/digiscreen_ynh.git synced 2024-09-03 18:26:15 +02:00
Code Issues Activity Actions

Merge pull request #1 from YunoHost-Apps/testing

Browse source 
First release of Digiscreen for Yunohost
This commit is contained in:
Melchisedech 2022-11-06 22:07:46 +01:00 • committed by GitHub
commit 31e913583f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 96 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -3,42 +3,42 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Digiwords for YunoHost # Digiscreen for YunoHost
[![Integration level](https://dash.yunohost.org/integration/digiwords.svg)](https://dash.yunohost.org/appci/app/digiwords) ![Working status](https://ci-apps.yunohost.org/ci/badges/digiwords.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/digiwords.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/digiscreen.svg)](https://dash.yunohost.org/appci/app/digiscreen) ![Working status](https://ci-apps.yunohost.org/ci/badges/digiscreen.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/digiscreen.maintain.svg)
[![Install Digiwords with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=digiwords) [![Install Digiscreen with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=digiscreen)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Digiwords quickly and simply on a YunoHost server. > *This package allows you to install Digiscreen 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
With Digiwords, you can create interactive wordclouds. An interactive wallpaper for the classroom, face-to-face or distant
**Shipped version:** 0.3.5~ynh1 **Shipped version:** 0.6.4~ynh1
**Demo:** https://ladigitale.dev/digiwords/#/ **Demo:** https://ladigitale.dev/digiscreen/
## Documentation and resources ## Documentation and resources
* Official app website: <https://ladigitale.dev/> * Official app website: <https://ladigitale.dev/>
* Official user documentation: <https://ladigitale.dev/blog/digiwords-pour-creer-des-nuages-de-mots> * Official user documentation: <https://ladigitale.dev/blog/digiscreen-un-fond-d-ecran-interactif-pour-la-classe>
* Official admin documentation: <https://codeberg.org/ladigitale/digiwords/src/branch/master/README.md> * Official admin documentation: <https://codeberg.org/ladigitale/digiscreen/src/branch/main/README.md>
* Upstream app code repository: <https://codeberg.org/ladigitale/digiwords> * Upstream app code repository: <https://codeberg.org/ladigitale/digiscreen>
* YunoHost documentation for this app: <https://yunohost.org/app_digiwords> * YunoHost documentation for this app: <https://yunohost.org/app_digiscreen>
* Report a bug: <https://github.com/YunoHost-Apps/digiwords_ynh/issues> * Report a bug: <https://github.com/YunoHost-Apps/digiscreen_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/digiwords_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/digiscreen_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/digiwords_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/digiscreen_ynh/tree/testing --debug
or or
sudo yunohost app upgrade digiwords -u https://github.com/YunoHost-Apps/digiwords_ynh/tree/testing --debug sudo yunohost app upgrade digiscreen -u https://github.com/YunoHost-Apps/digiscreen_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

30
README_fr.md
View file

@ -3,42 +3,42 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Digiwords pour YunoHost # Digiscreen pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/digiwords.svg)](https://dash.yunohost.org/appci/app/digiwords) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/digiwords.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/digiwords.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/digiscreen.svg)](https://dash.yunohost.org/appci/app/digiscreen) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/digiscreen.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/digiscreen.maintain.svg)
[![Installer Digiwords avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=digiwords) [![Installer Digiscreen avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=digiscreen)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Digiwords rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Digiscreen 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
Digiwords permet de créer des nuages de mots interactifs. Un fond d'écran interactif pour la salle de classe en présence ou à distance.
**Version incluse :** 0.3.5~ynh1 **Version incluse :** 0.6.4~ynh1
**Démo :** https://ladigitale.dev/digiwords/#/ **Démo :** https://ladigitale.dev/digiscreen/
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://ladigitale.dev/> * Site officiel de l'app : <https://ladigitale.dev/>
* Documentation officielle utilisateur : <https://ladigitale.dev/blog/digiwords-pour-creer-des-nuages-de-mots> * Documentation officielle utilisateur : <https://ladigitale.dev/blog/digiscreen-un-fond-d-ecran-interactif-pour-la-classe>
* Documentation officielle de l'admin : <https://codeberg.org/ladigitale/digiwords/src/branch/master/README.md> * Documentation officielle de l'admin : <https://codeberg.org/ladigitale/digiscreen/src/branch/main/README.md>
* Dépôt de code officiel de l'app : <https://codeberg.org/ladigitale/digiwords> * Dépôt de code officiel de l'app : <https://codeberg.org/ladigitale/digiscreen>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_digiwords> * Documentation YunoHost pour cette app : <https://yunohost.org/app_digiscreen>
* Signaler un bug : <https://github.com/YunoHost-Apps/digiwords_ynh/issues> * Signaler un bug : <https://github.com/YunoHost-Apps/digiscreen_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/digiwords_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/digiscreen_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/digiwords_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/digiscreen_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade digiwords -u https://github.com/YunoHost-Apps/digiwords_ynh/tree/testing --debug sudo yunohost app upgrade digiscreen -u https://github.com/YunoHost-Apps/digiscreen_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>

6
check_process
View file

@ -20,7 +20,7 @@
setup_private=1 setup_private=1
setup_public=1 setup_public=1
upgrade=1 upgrade=1
upgrade=1 from_commit=cc131db79e58280d13674c7a99cb6d21cd67f7d5 upgrade=1 from_commit=3bb42cd71bcca77b7f642859bf5048317586a500
backup_restore=1 backup_restore=1
multi_instance=1 multi_instance=1
port_already_use=0 port_already_use=0
@ -29,6 +29,6 @@
Email= Email=
Notification=none Notification=none
;;; Upgrade options ;;; Upgrade options
; commit=cc131db79e58280d13674c7a99cb6d21cd67f7d5 ; commit=3bb42cd71bcca77b7f642859bf5048317586a500
;name=Bump from 0.3.3. ;name=First release.
;manifest_arg=domain=DOMAIN&path=PATH&language=fr&is_public=1& ;manifest_arg=domain=DOMAIN&path=PATH&language=fr&is_public=1&

4
conf/app.src
View file

@ -1,5 +1,5 @@
SOURCE_URL=https://github.com/YunoHost-Apps/digiwords_ynh/releases/download/0.3.5/digiwords-v0.3.5.zip SOURCE_URL=https://github.com/YunoHost-Apps/digiscreen_ynh/releases/download/0.6.4/digiscreen-0.6.4.zip
SOURCE_SUM=cba502b1e853cc4e54a07168e8811e829aab0dbd260f0069b7e2c97acf31ef27 SOURCE_SUM=92273e360e06639283ee9db746d1d53006af7ea405f1ecbe85a262b39eae6756
SOURCE_SUM_PRG=sha256sum SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=zip SOURCE_FORMAT=zip
SOURCE_IN_SUBDIR=true SOURCE_IN_SUBDIR=true

55
manifest.json
View file

@ -1,20 +1,20 @@
{ {
"name": "Digiwords", "name": "Digiscreen",
"id": "digiwords", "id": "digiscreen",
"packaging_format": 1, "packaging_format": 1,
"description": { "description": {
"en": "With Digiwords, you can create interactive wordclouds.", "en": "An interactive wallpaper for the classroom, face-to-face or distant",
"fr": "Digiwords permet de créer des nuages de mots interactifs." "fr": "Un fond d'écran interactif pour la salle de classe en présence ou à distance."
}, },
"version": "0.3.5~ynh1", "version": "0.6.4~ynh1",
"url": "https://ladigitale.dev/", "url": "https://ladigitale.dev/",
"upstream": { "upstream": {
"license": "GPL-3.0-only", "license": "GPL-3.0-only",
"website": "https://ladigitale.dev/", "website": "https://ladigitale.dev/",
"demo": "https://ladigitale.dev/digiwords/#/", "demo": "https://ladigitale.dev/digiscreen/",
"admindoc": "https://codeberg.org/ladigitale/digiwords/src/branch/master/README.md", "admindoc": "https://codeberg.org/ladigitale/digiscreen/src/branch/main/README.md",
"userdoc": "https://ladigitale.dev/blog/digiwords-pour-creer-des-nuages-de-mots", "userdoc": "https://ladigitale.dev/blog/digiscreen-un-fond-d-ecran-interactif-pour-la-classe",
"code": "https://codeberg.org/ladigitale/digiwords" "code": "https://codeberg.org/ladigitale/digiscreen"
}, },
"license": "GPL-3.0-only", "license": "GPL-3.0-only",
"maintainer": { "maintainer": {
@ -22,7 +22,7 @@
"email": "xxxxx" "email": "xxxxx"
}, },
"requirements": { "requirements": {
"yunohost": ">= 4.3.0" "yunohost": ">= 11.0.10.1"
}, },
"multi_instance": true, "multi_instance": true,
"services": [ "services": [
@ -39,18 +39,45 @@
"name": "path", "name": "path",
"type": "path", "type": "path",
"example": "/example", "example": "/example",
"default": "/digiwords" "default": "/digiscreen"
},
{
"name": "pixabay",
"type": "string",
"example": "123456abc",
"optional": true,
"ask": {
"en": "Your Pixabay API key:",
"fr": "Votre clé d’API Pixabay :"
},
"help": {
"en": "Optional: a Pixabay API key will let you chose a background by entering keywords.",
"fr": "Optionnel : une clé d’API Pixabay vous permettra de choisir un fond d’écran en entrant un mot clé."
}
},
{
"name": "googleYoutube",
"type": "string",
"example": "123456abc",
"optional": true,
"ask": {
"en": "Your Google API key:",
"fr": "Votre clé d’API Google :"
},
"help": {
"en": "Optional: a Google API key will let you insert videos from Youtube on your Digiscreen",
"fr": "Optionnel : une clé d’API Google vous permettra d’afficher des vidéos de Youtube sur votre Digiscreen."
}
}, },
{ {
"name": "is_public", "name": "is_public",
"type": "boolean", "type": "boolean",
"help": { "help": {
"en": "If public, any visitor can create word clouds and see saved ones, providing they know their secret questions and answers.", "en": "If public, any visitor can use this app and thus will benefit from your API keys for Pixabay and Youtube.",
"fr": "Si l’application est publique, n’importe quel visiteur pourra créer un nuage de mots et consulter ceux sauvegardés dont ils connaissent à la fois la question secrète et la réponse." "fr": "Si l’application est publique, n’importe quel visiteur pourra utiliser cette application et bénéficiera donc de vos clés d’API pour Pixabay et Youtube."
}, },
"default": true "default": true
} }
] ]
} }
} }

3
scripts/_common.sh
View file

@ -5,7 +5,8 @@
#================================================= #=================================================
# dependencies used by the app # dependencies used by the app
pkg_dependencies="php$YNH_DEFAULT_PHP_VERSION-sqlite3" pkg_dependencies=""
nodejs_version="14.19.3"
#================================================= #=================================================
# PERSONAL HELPERS # PERSONAL HELPERS

20
scripts/install
View file

@ -30,6 +30,8 @@ path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC is_public=$YNH_APP_ARG_IS_PUBLIC
#language=$YNH_APP_ARG_LANGUAGE #language=$YNH_APP_ARG_LANGUAGE
#password=$YNH_APP_ARG_PASSWORD #password=$YNH_APP_ARG_PASSWORD
pixabay=$YNH_APP_ARG_PIXABAY
googleYoutube=$YNH_APP_ARG_GOOGLEYOUTUBE
### If it's a multi-instance app, meaning it can be installed several times independently ### If it's a multi-instance app, meaning it can be installed several times independently
### The id of the app as stated in the manifest is available as $YNH_APP_ID ### The id of the app as stated in the manifest is available as $YNH_APP_ID
@ -111,7 +113,7 @@ ynh_script_progression --message="Installing dependencies..." --weight=1
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script ### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script ### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
ynh_install_app_dependencies $pkg_dependencies #ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# CREATE DEDICATED USER # CREATE DEDICATED USER
@ -151,7 +153,21 @@ ynh_script_progression --message="Setting up source files..." --weight=1
ynh_app_setting_set --app=$app --key=final_path --value=$final_path ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path" working_path=/tmp/$app
ynh_setup_source --dest_dir="$working_path"
cd $working_path
echo VUE_APP_PIXABAY_API_KEY="$pixabay" >> .env
echo VUE_APP_GOOGLE_API_KEY="$googleYoutube" >> .env
ynh_install_nodejs --nodejs_version=$nodejs_version
ynh_use_nodejs
ynh_npm install
ynh_npm run build
mv $working_path/dist $final_path
ynh_secure_remove --file=$working_path
# FIXME: this should be managed by the core in the future # FIXME: this should be managed by the core in the future
# Here, as a packager, you may have to tweak the ownerhsip/permissions # Here, as a packager, you may have to tweak the ownerhsip/permissions