Mise en route de l’application

Comment forker et configurer un dépôt d’application de bureau basé sur Pankosmia

Table des matières

Forker desktop-app-template

Desktop-app-template est un dépôt conçu pour être forké afin de créer et maintenir de nouveaux dépôts d’applications de bureau basés sur Pankosmia.

  1. Commencez à https://github.com/pankosmia/desktop-app-template/fork

  2. Choisissez un nom de dépôt de 30 caractères ou moins si vous voulez éviter aux développeurs Windows de devoir cloner avec un nom de dépôt local plus court. Le compilateur C de cargo build sous Windows exige des noms de dépôt de 30 caractères ou moins.

  3. Créer le fork

Configuration

Structure de répertoires recommandée : 

    |-- repos
    |-- pankosmia
        |-- [your-desktop-app-repo-name] (30 caractères ou moins sous Windows !)

package.json

Remplacez toutes les occurrences de « desktop-app-template » dans package.json par « [your-desktop-app-repo-name] »

À la racine de votre clone de ce dépôt, exécutez : 

    npm install

Modifier app_config.env

Saisir le nom de l’application, le numéro de version, le nom court de l’application pour le répertoire de travail, les assets et les clients.

Assets requis :

  • ASSET1=resource-core
  • ASSET1_PATH=/runtime_resources
  • ASSET1_NAME=app_resources
  • ASSET2=resource-core
  • ASSET2_PATH=/templates
  • ASSET2_NAME=templates
  • ASSET3=webfonts-core
  • ASSET3_PATH=/
  • ASSET3_NAME=webfonts

Clients requis :

  • CLIENT1=core-client-dashboard
  • CLIENT2=core-client-content
  • CLIENT[n’importe quel nombre]=core-client-settings
  • CLIENT[n’importe quel nombre]=core-contenthandler-generic
  • # Gardez la numérotation séquentielle. Ne sautez pas de numéros.

Image de marque

Modifiez directement /globalBuildResources/theme.json pour personnaliser votre application. Pour des conseils utiles, consultez la section Thème des directives UX/UI.

Pour implémenter votre logo, consultez le README Branding pour les scripts de personnalisation de /globalBuildResources/.ico, /globalBuildResources/.png et /globalBuildResources/icon.icns, ainsi que des informations sur l’utilisation de chacun.

Scripts de configuration

cd [os]/scripts

Exécutez[1] le script clone pour cloner tous les dépôts listés dans app_config.env (assets et clients)

Exécutez[1] le script app_setup pour générer les fichiers de configuration correspondant à app_config.env. Ré-exécutez[1] le script app_setup chaque fois que app_config.env est modifié.

Exécutez[1] le script build_clients pour compiler tous les clients. Soyez patient. Cela prendra du temps.

  • Ce script utilise par défaut toutes les branches main, récupère la dernière version et compile chaque client à chaque exécution.
  • Spécifiez des branches autres que main en arguments : ./build_clients.[ext] [my-branch|dev|qa] [dev|qa][1]. Lorsque « my-branch » n’existe pas, le repli sera « main » sauf si l’argument suivant est spécifié. Si « dev » est indiqué, un repli « dev » → « qa » → « main » est implicite. Si « qa » est indiqué, un repli « qa » → « main » est implicite. Pour compiler des dépôts manuellement, exécutez npm run build uniquement sur ces dépôts selon les besoins.

Exécutez[1] le script build_server pour compiler le serveur Pankosmia et assembler l’environnement de build. Lorsque /local_server.env contient des versions différentes de panksomia_web dans /local_server/Cargo.toml, utilisez ./build_server.[ext] *dev* pour compiler un serveur de développement local, et ./build_server.[ext] qa pour compiler un serveur qa local. Soyez patient, cela prendra du temps.

(Optionnel) Exécutez[1] le script build_viewer pour créer une visionneuse Electronite à utiliser avec l’environnement de développement local. Soyez patient, surtout sous Windows.

Exécuter votre configuration

Exécutez[1] le script run pour démarrer le serveur sans lancer de navigateur.

  • Une seule instance du même serveur peut s’exécuter à la fois.

Exécutez le script viewer pour utiliser la visionneuse Electronite avec l’environnement de build de développement local, ou lancez un navigateur à l’emplacement indiqué.

Notes de bas de page

[1] … Développeurs Windows, exécutez les scripts .bat depuis un Powershell ou une invite de commandes :
…repos\pankosmia[your-desktop-app-repo-name]\windows\scripts> .[scriptname].bat
Le .\ est facultatif depuis une invite de commandes.
Utilisez un terminal powershell pour les scripts de build .ps1.
Développeurs MacOS, exécutez les scripts .bsh depuis un terminal MacOS :
…repos/pankosmia/[your-desktop-app-repo-name]/macos/scripts> ./[scriptname].bsh
Développeurs Linux, exécutez les scripts .zsh depuis un terminal linux :
…repos/pankosmia/[your-desktop-app-repo-name]/linux/scripts> ./[scriptname].zsh