diff --git a/README.md b/README.md index 7b18b19..2fa9e38 100644 --- a/README.md +++ b/README.md @@ -3,42 +3,42 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app 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) -[![Install Digiwords with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=digiwords) +[![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 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)* -> *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.* ## 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 * Official app website: -* Official user documentation: -* Official admin documentation: -* Upstream app code repository: -* YunoHost documentation for this app: -* Report a bug: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## 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. ``` 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 -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:** diff --git a/README_fr.md b/README_fr.md index 5f7fdf4..d9982e7 100644 --- a/README_fr.md +++ b/README_fr.md @@ -3,42 +3,42 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app 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) -[![Installer Digiwords avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=digiwords) +[![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 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)* -> *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.* ## 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 * Site officiel de l'app : -* Documentation officielle utilisateur : -* Documentation officielle de l'admin : -* Dépôt de code officiel de l'app : -* Documentation YunoHost pour cette app : -* Signaler un bug : +* Documentation officielle utilisateur : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## 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. ``` 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 -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 :** diff --git a/check_process b/check_process index ca8532e..8cae27c 100644 --- a/check_process +++ b/check_process @@ -20,7 +20,7 @@ setup_private=1 setup_public=1 upgrade=1 - upgrade=1 from_commit=cc131db79e58280d13674c7a99cb6d21cd67f7d5 + upgrade=1 from_commit=3bb42cd71bcca77b7f642859bf5048317586a500 backup_restore=1 multi_instance=1 port_already_use=0 @@ -29,6 +29,6 @@ Email= Notification=none ;;; Upgrade options - ; commit=cc131db79e58280d13674c7a99cb6d21cd67f7d5 - ;name=Bump from 0.3.3. + ; commit=3bb42cd71bcca77b7f642859bf5048317586a500 + ;name=First release. ;manifest_arg=domain=DOMAIN&path=PATH&language=fr&is_public=1& diff --git a/conf/app.src b/conf/app.src index 5939d80..52bbfa6 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,5 +1,5 @@ -SOURCE_URL=https://github.com/YunoHost-Apps/digiwords_ynh/releases/download/0.3.5/digiwords-v0.3.5.zip -SOURCE_SUM=cba502b1e853cc4e54a07168e8811e829aab0dbd260f0069b7e2c97acf31ef27 +SOURCE_URL=https://github.com/YunoHost-Apps/digiscreen_ynh/releases/download/0.6.4/digiscreen-0.6.4.zip +SOURCE_SUM=92273e360e06639283ee9db746d1d53006af7ea405f1ecbe85a262b39eae6756 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=true diff --git a/manifest.json b/manifest.json index 8347769..c5661a1 100644 --- a/manifest.json +++ b/manifest.json @@ -1,20 +1,20 @@ { - "name": "Digiwords", - "id": "digiwords", + "name": "Digiscreen", + "id": "digiscreen", "packaging_format": 1, "description": { - "en": "With Digiwords, you can create interactive wordclouds.", - "fr": "Digiwords permet de créer des nuages de mots interactifs." + "en": "An interactive wallpaper for the classroom, face-to-face or distant", + "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/", "upstream": { "license": "GPL-3.0-only", "website": "https://ladigitale.dev/", - "demo": "https://ladigitale.dev/digiwords/#/", - "admindoc": "https://codeberg.org/ladigitale/digiwords/src/branch/master/README.md", - "userdoc": "https://ladigitale.dev/blog/digiwords-pour-creer-des-nuages-de-mots", - "code": "https://codeberg.org/ladigitale/digiwords" + "demo": "https://ladigitale.dev/digiscreen/", + "admindoc": "https://codeberg.org/ladigitale/digiscreen/src/branch/main/README.md", + "userdoc": "https://ladigitale.dev/blog/digiscreen-un-fond-d-ecran-interactif-pour-la-classe", + "code": "https://codeberg.org/ladigitale/digiscreen" }, "license": "GPL-3.0-only", "maintainer": { @@ -22,7 +22,7 @@ "email": "xxxxx" }, "requirements": { - "yunohost": ">= 4.3.0" + "yunohost": ">= 11.0.10.1" }, "multi_instance": true, "services": [ @@ -39,18 +39,45 @@ "name": "path", "type": "path", "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", "type": "boolean", "help": { - "en": "If public, any visitor can create word clouds and see saved ones, providing they know their secret questions and answers.", - "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." + "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 utiliser cette application et bénéficiera donc de vos clés d’API pour Pixabay et Youtube." }, "default": true } ] } } - diff --git a/scripts/_common.sh b/scripts/_common.sh index 5007fea..e8accab 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,8 @@ #================================================= # dependencies used by the app -pkg_dependencies="php$YNH_DEFAULT_PHP_VERSION-sqlite3" +pkg_dependencies="" +nodejs_version="14.19.3" #================================================= # PERSONAL HELPERS diff --git a/scripts/install b/scripts/install index d4ab396..72fcd55 100644 --- a/scripts/install +++ b/scripts/install @@ -30,6 +30,8 @@ path_url=$YNH_APP_ARG_PATH is_public=$YNH_APP_ARG_IS_PUBLIC #language=$YNH_APP_ARG_LANGUAGE #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 ### 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 ### - And the section "UPGRADE DEPENDENCIES" in the upgrade script -ynh_install_app_dependencies $pkg_dependencies +#ynh_install_app_dependencies $pkg_dependencies #================================================= # 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 # 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 # Here, as a packager, you may have to tweak the ownerhsip/permissions