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

Windows, MacOS ou Linux

Prérequis

Voir Exigences de l’environnement.
Consultez Mise en route de l’application et Scripts.

Visionneuse de développement Electronite

💡 Pour créer une visionneuse Electronite à utiliser avec votre environnement de build de développement local, exécutez ce script une fois en étant en ligne :
- 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
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.

💡 Pour développer dans Electronite, commencez par modifier le code utilisé par votre visionneuse de développement. La structure de fichiers sur laquelle se concentrer est ci-dessous, en particulier electronStartup.js et preload.js. Effectuez d’abord les modifications ici pour tester en développement local :

|-- [linux | windows | macos]
    |-- viewer
        |-- project
            |-- payload
                |-- app
                    |-- appLauncherElectron.sh | appLauncherElectron.bat
                    |-- electron
                        |-- electronStartup.js
                        |-- favicon.png
                        |-- favicon@1.5x.png
                        |-- favicon@1.25x.png
                        |-- favicon@1.75x.png
                        |-- favicon@2x.png
                        |-- preload.js

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

Si des modifications de electronStartup.js sont nécessaires, reproduisez ces modifications dans les deux fichiers suivants :

|-- buildResources
    |-- electron
        |-- electronDevStartup.js (utilisé par la visionneuse et l’application Linux ; lance la visionneuse sans démarrer le serveur)
        |-- electronStartup.js (utilisé par les applications Windows et MacOS ; démarre le serveur puis lance la visionneuse)

Testez electronDevStartup.js en relançant le script build_viewer. Voir Visionneuse de développement Electronite ci-dessus. Également utilisé dans l’application Linux.

Testez electronStartup.js en compilant localement sous Windows ou MacOS, ou en poussant une branche, en compilant via GitHub Actions, puis en testant les installations autonomes résultantes pour Windows/MacOS.

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.

Si une modification doit être apportée au script appLauncherElectron, elle devra être effectuée à 3 endroits différents et testée sur trois systèmes d’exploitation différents. Ces fichiers se trouvent à :

linux\buildResources\appLauncherElectron.sh
windows\buildResources\appLauncherElectron.bat
macos\buildResources\appLauncherElectron.sh

Testez en compilant localement sur les trois systèmes d’exploitation, ou en poussant une branche, en compilant via GitHub Actions, puis en testant les installations autonomes résultantes.

Build d’installateur local

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

Prérequis :

Assurez-vous que le serveur (script build_server) est à jour !
Windows a une exigence supplémentaire pour exécuter ce build bundle_viewer localement :
- Installez Inno Setup - testé avec la v6.4.3

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 npm ci, 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 npm ci, 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
  - npm ci (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]-windows-setup-standalone-[version].exe
MacOS: releases/macos/[intel64|arm64]/[app-name]-macos-installer-standalone-[intel64|arm64]-[version].pkg
Linux: releases/linux/[app-name]-linux-standalone-intel64-[version].deb