Desarrollo local de Electronite

Cómo realizar cambios en Electronite mientras se usa un servidor de desarrollo local.

Tabla de contenidos

Windows, MacOS o Linux

Windows, MacOS o Linux

Requisitos previos

Vea Requisitos del entorno.
Consulte Puesta en marcha de la aplicación y Scripts.

Visor de desarrollo Electronite

💡 Para crear un visor Electronite para usar con su entorno de build de desarrollo local, ejecute este script una vez estando en línea:
- Linux: cd linux/scripts luego ./build_viewer.bsh
- Windows: cd windows\\scripts luego .\build_viewer.ps1 (use un terminal powershell)
- MacOS: cd macos/scripts luego ./build_viewer.zsh
Lea las secciones ‘Uso’ y ‘Desarrollo de clientes’ en la parte superior de Scripts.

💡 Cuando el servidor esté en ejecución (el script run), inicie el visor Electronite creado por el script build_viewer:
- Linux: cd linux/scripts luego ./viewer.bsh – Herramientas de desarrollo: Ctrl + Shift + I”
- Windows: cd windows\scripts luego .\viewer.bat – Herramientas de desarrollo: Ctrl + Shift + I”
- MacOS: cd macos/scripts luego ./viewer.zsh – Herramientas de desarrollo: Cmd + Option + I”

Realizar cambios de desarrollo en Electronite

Electronite es un reemplazo directo de Electron que proporciona un sistema de renderizado de fuentes mejorado. Realice sus cambios de desarrollo de la misma manera que para un visor Electron.

Este proyecto funciona tanto en un navegador web como en el visor Electronite. Solo agregue código a Electron/Electronite que sea necesario para manejar cosas que el navegador web ya hace (por ejemplo, Imprimir, Buscar, Zoom, Atrás, Adelante). Evite codificar de una manera que impida el uso del navegador web.

💡 La forma de desarrollar en Electronite es comenzar modificando el código utilizado por su visor de desarrollo. La estructura de archivos en la que centrarse está a continuación, en particular electronStartup.js y preload.js. Haga los cambios aquí primero para probar en desarrollo 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

Desplegar los cambios de desarrollo probados en Electronite

Si se requieren cambios en electronStartup.js, reproduzca estos cambios en los dos archivos siguientes:

|-- buildResources
    |-- electron
        |-- electronDevStartup.js (utilizado por el visor y la aplicación Linux; lanza el visor sin iniciar el servidor)
        |-- electronStartup.js (utilizado por las aplicaciones Windows y MacOS; inicia el servidor y luego lanza el visor)

Pruebe electronDevStartup.js volviendo a ejecutar el script build_viewer. Vea Visor de desarrollo Electronite arriba. También se usa en la aplicación Linux.

Pruebe electronStartup.js compilando localmente en Windows o MacOS, o enviando una rama, compilando mediante GitHub Actions y luego probando las instalaciones independientes resultantes para Windows/MacOS.

Si se necesita un cambio en favicon*.png, realice esos cambios en el directorio globalBuildResources. Se aplican las mismas instrucciones de prueba anteriores.

Si se necesita un cambio en el script appLauncherElectron, deberá realizarse en 3 lugares diferentes y probarse en tres sistemas operativos diferentes. Esos archivos se encuentran en:

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

Pruebe compilando localmente en los tres sistemas operativos, o enviando una rama, compilando mediante GitHub Actions y luego probando las instalaciones independientes resultantes.

Build de instalador local

Antes de hacer esto, considere también Para generar artefactos

Requisitos previos:

¡Asegúrese de que el servidor (script build_server) esté actualizado!
Windows tiene un requisito adicional para ejecutar este build bundle_viewer localmente:
- Instale Inno Setup - probado con v6.4.3

Script bundle_viewer

Windows - cd windows\scripts luego .\bundle_viewer.ps1
- Argumentos opcionales:
  - .\bundle_viewer.ps1 -ServerOff "Y"
    o: “y”; No preguntará si el servidor está apagado
- Elimina los últimos bundles y el contenido temporal del sistema operativo dado (si existen), luego en este repositorio ejecuta git checkout main, git pull y npm ci, ejecuta app_setup.bat para asegurar la consistencia de versiones, ejecuta node build.js, y luego crea un bundle de release zip y un instalador exe independiente.
MacOS - cd /macos/scripts luego ./bundle_viewer.zsh
- Argumentos opcionales:
  - ./bundle_viewer.zsh -s
    No preguntará si el servidor está apagado
- Elimina los últimos bundles y el contenido temporal del sistema operativo dado (si existen), luego en este repositorio ejecuta git checkout main, git pull y npm ci, ejecuta app_setup.bat para asegurar la consistencia de versiones, ejecuta node build.js, y luego crea un bundle de release zip y un instalador exe independiente.
Linux - cd /linux/scripts luego ./bundle_viewer.bsh
- Antes de ejecutar:
  - elimine manualmente los builds locales anteriores
  - npm ci (si no se ha ejecutado ya)
  - app_setup.bat para asegurar la consistencia de versiones (a menos que ya esté actualizado)
  - ejecute ./bundle_tgz.bsh
  - luego ejecute ./bundle_viewer.bsh

Salidas del 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