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

Requisitos previos

  1. Vea Requisitos del entorno.

  2. Consulte Puesta en marcha de la aplicación y Scripts.

Visor de desarrollo Electronite

  1. 💡 Para crear un visor Electronite para usar con su entorno de build de desarrollo local, ejecute este script con conexión a Internet:
    • 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

  2. 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.

💡 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

Desplegar los cambios de desarrollo probados en Electronite

Pruebe volviendo a ejecutar el script build_viewer. Vea Visor de desarrollo Electronite arriba. Esto configurará los archivos de Electron mencionados arriba en la siguiente ubicación con las variables específicas de la aplicación configuradas.

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

Pruebe bundle_viewer.<bsh|ps1|zsh> compilando localmente en Windows o MacOS, o enviando una rama, compilando mediante GitHub Actions y luego probando las instalaciones resultantes.

¡Los paquetes requeridos se copian mediante el script!

Si los paquetes requeridos en Electron se cambian o actualizan, no basta con gestionarlos en el package.json de la raíz del repositorio, ya que los archivos correspondientes de este repositorio se copian en las instalaciones en lugar de ser gestionados por un gestor de paquetes. Consulta la información adicional para realizar y probar los cambios.

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

Build de instalador local

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

Requisitos previos:

  • ¡Asegúrese de que el servidor local esté actualizado! Esto es el script build_server, o ./build_server.[ext] dev o ./build_server.[ext] qa si /local_server.env tiene versiones diferentes de panksomia_web en /local_server/Cargo.toml.

  • Windows tiene un requisito adicional para ejecutar este build bundle_viewer localmente:

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 pnpm i, 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 pnpm i, 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
      • pnpm i (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]-[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