Développement local Electronite

Comment apporter des modifications à Electronite en utilisant un serveur de développement local.

Table des matières

Windows, MacOS ou Linux

Prérequis

  1. Voir Exigences de l’environnement.

  2. Consultez Mise en route de l’application et Scripts.

Visionneuse de développement Electronite

  1. 💡 Pour créer une visionneuse Electronite à utiliser avec votre environnement de build de développement local, exécutez ce script en étant connecté à Internet :
    • Linux: cd linux/scripts puis ./build_viewer.bsh
    • Windows: cd windows\\scripts puis .\build_viewer.ps1 (utilisez un terminal powershell)
    • MacOS: cd macos/scripts puis ./build_viewer.zsh

  2. Lisez les sections « Utilisation » et « Développement de clients » en haut de Scripts.

  • 💡 Lorsque le serveur est en cours d’exécution (le script run), démarrez la visionneuse Electronite créée par le script build_viewer :
    • Linux: cd linux/scripts puis ./viewer.bsh – Outils de développement : Ctrl + Shift + I”
    • Windows: cd windows\scripts puis .\viewer.bat – Outils de développement : Ctrl + Shift + I”
    • MacOS: cd macos/scripts puis ./viewer.zsh – Outils de développement : Cmd + Option + I”

Apporter des modifications de développement à Electronite

Electronite est un remplacement direct d’Electron qui fournit un système de rendu de polices amélioré. Effectuez vos modifications de développement de la même manière que pour une visionneuse Electron.

Ce projet fonctionne aussi bien dans un navigateur web que dans la visionneuse Electronite. N’ajoutez du code à Electron/Electronite que pour gérer ce que le navigateur web fait déjà (par exemple, Imprimer, Rechercher, Zoom, Précédent, Suivant). Évitez de coder d’une manière qui empêche l’utilisation du navigateur web.

💡 The way to develop in Electronite is to start by modifying sourcecode in the following location. The electron orechestrator is electronStartup.js.

└── buildResources
    └── electron
        ├── config
        │   └── paths.js
        ├── core
        │   ├── archiveUtil.js
        │   ├── downloadUtil.js
        │   ├── ports.js
        │   ├── server.js
        │   ├── startupErrors.js
        │   └── window.js
        ├── features
        │   ├── ffmpeg.js
        │   ├── firefox.js
        │   └── pdf.js
        ├── electronStartup.js
        ├── package.json
        └── preload.js

Déployer les modifications de développement testées vers Electronite

Testez en relançant le script build_viewer. Voir Visionneuse de développement Electronite ci-dessus. Cela configurera les fichiers Electron ci-dessus à l’emplacement suivant avec les variables spécifiques à l’application configurées.

└── [linux | windows | macos]
    └── viewer
        └── project
            └── payload
                └── app
                    └── electron

Testez bundle_viewer.<bsh|ps1|zsh> en compilant localement sous Windows ou MacOS, ou en poussant une branche, en compilant via GitHub Actions, puis en testant les installations résultantes.

Les paquets requis sont copiés par le script !

Si les paquets requis dans Electron sont modifiés ou mis à jour, il ne suffit pas de les gérer dans le fichier package.json à la racine du dépôt, car les fichiers concernés de ce dépôt sont copiés dans les installations au lieu d’être gérés par un gestionnaire de paquets. Consultez les informations complémentaires pour effectuer et tester les modifications.

Si une modification doit être apportée à favicon*.png, effectuez ces modifications dans le répertoire globalBuildResources. Les mêmes instructions de test ci-dessus s’appliquent.

Build d’installateur local

Avant de procéder, consultez également Pour générer des artefacts

Prérequis :

  • Assurez-vous que le serveur local est à jour ! Il s’agit du script build_server, ou ./build_server.[ext] dev ou ./build_server.[ext] qa si /local_server.env contient des versions différentes de panksomia_web dans /local_server/Cargo.toml.

  • Windows a une exigence supplémentaire pour exécuter ce build bundle_viewer localement :

Script bundle_viewer

  • Windows - cd windows\scripts puis .\bundle_viewer.ps1
    • Arguments optionnels :

      • .\bundle_viewer.ps1 -ServerOff "Y"
        ou : « y » ; Ne demandera pas si le serveur est arrêté

    • Supprime les derniers bundles et le contenu temporaire pour le système d’exploitation donné (s’ils existent), puis sur ce dépôt exécute git checkout main, git pull et pnpm i, exécute app_setup.bat pour assurer la cohérence des versions, exécute node build.js, puis crée un bundle de release zip et un installateur exe autonome.
  • MacOS - cd /macos/scripts puis ./bundle_viewer.zsh
    • Arguments optionnels :

      • ./bundle_viewer.zsh -s
        Ne demandera pas si le serveur est arrêté

    • Supprime les derniers bundles et le contenu temporaire pour le système d’exploitation donné (s’ils existent), puis sur ce dépôt exécute git checkout main, git pull et pnpm i, exécute app_setup.bat pour assurer la cohérence des versions, exécute node build.js, puis crée un bundle de release zip et un installateur exe autonome.
  • Linux - cd /linux/scripts puis ./bundle_viewer.bsh
    • Avant l’exécution :
      • supprimez manuellement les builds locaux précédents
      • pnpm i (si pas déjà exécuté)
      • app_setup.bat pour assurer la cohérence des versions (sauf si déjà à jour)

      • exécutez ./bundle_tgz.bsh

      • puis exécutez ./bundle_viewer.bsh

Sorties du script bundle_viewer :

  • Windows: releases\\windows\\intel64\\[app-name]-[version]-windows-[x64|arm64].exe
  • MacOS: releases/macos/[intel64|arm64]/[app-name]-[version]-macos-[x64|arm64].pkg
  • Linux: releases/linux/[app-name]-[version]-linux-[x64|arm64].deb