Puesta en marcha de la aplicación

Cómo hacer fork y configurar un repositorio de aplicación de escritorio basado en Pankosmia

Tabla de contenidos

Hacer fork de desktop-app-template

Desktop-app-template es un repositorio diseñado para ser bifurcado (fork) para crear y mantener nuevos repositorios de aplicaciones de escritorio basados en Pankosmia.

  1. Comience en https://github.com/pankosmia/desktop-app-template/fork

  2. Elija un nombre de repositorio de 30 caracteres o menos si desea evitar que los desarrolladores Windows necesiten clonar con un nombre de repositorio local más corto. El compilador C de cargo build en Windows requiere nombres de repositorio de 30 caracteres o menos.

  3. Crear el fork

Configuración

Estructura de directorios recomendada: 

    |-- repos
    |-- pankosmia
        |-- [your-desktop-app-repo-name] (¡30 caracteres o menos en Windows!)

package.json

Reemplace todas las instancias de “desktop-app-template” en package.json por “[your-desktop-app-repo-name]”

En la raíz de su clon de este repositorio, ejecute: 

    npm install

Editar app_config.env

Ingrese el nombre de la aplicación, el número de versión, el nombre corto de la aplicación para el directorio de trabajo, los assets y los clientes.

Assets requeridos:

  • 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

Clientes requeridos:

  • CLIENT1=core-client-dashboard
  • CLIENT2=core-client-content
  • CLIENT[cualquier número]=core-client-settings
  • CLIENT[cualquier número]=core-contenthandler-generic
  • # Mantenga la numeración secuencial. No omita números.

Marca

Modifique /globalBuildResources/theme.json directamente para personalizar su aplicación. Para consejos útiles, consulte la sección Tema de las directrices UX/UI.

Para implementar su logo, consulte el README de Branding para los scripts de personalización de /globalBuildResources/.ico, /globalBuildResources/.png y /globalBuildResources/icon.icns, junto con información sobre cómo se usa cada uno.

Scripts de configuración

cd [os]/scripts

Ejecute[1] el script clone para clonar todos los repositorios listados en app_config.env (assets y clientes)

Ejecute[1] el script app_setup para generar los archivos de configuración que correspondan a app_config.env. Vuelva a ejecutar[1] el script app_setup cada vez que se modifique app_config.env.

Ejecute[1] el script build_clients para compilar todos los clientes. Tenga paciencia. Esto tomará un tiempo.

  • Este script usa por defecto todas las ramas main, obtiene la última versión y compila cada cliente cada vez que se ejecuta.
  • Especifique ramas distintas de main como argumentos: ./build_clients.[ext] [my-branch|dev|qa] [dev|qa][1]. Donde “my-branch” no exista, el respaldo será “main” a menos que se especifique el siguiente argumento. Si se indica “dev”, se implica un respaldo “dev” → “qa” → “main”. Si se indica “qa”, se implica un respaldo “qa” → “main”. Para compilar repositorios manualmente, ejecute npm run build solo en esos repositorios según sea necesario.

Ejecute[1] el script build_server para compilar el servidor Pankosmia y ensamblar el entorno de build. Cuando /local_server.env tenga versiones diferentes de panksomia_web en /local_server/Cargo.toml, use ./build_server.[ext] dev para compilar un servidor de desarrollo local, y ./build_server.[ext] qa para compilar un servidor qa local. Tenga paciencia, esto tomará un tiempo.

(Opcional) Ejecute[1] el script build_viewer para crear un visor Electronite para usar con el entorno de desarrollo local. Tenga paciencia, especialmente en Windows.

Ejecutar su configuración

Ejecute[1] el script run para iniciar el servidor sin abrir un navegador.

  • Solo puede ejecutarse una instancia del mismo servidor a la vez.

Ejecute el script viewer para usar el visor Electronite con el entorno de build de desarrollo local, o abra un navegador en la ubicación indicada.

Notas al pie

[1] … Desarrolladores Windows, ejecuten los scripts .bat desde un Powershell o símbolo del sistema:
…repos\pankosmia[your-desktop-app-repo-name]\windows\scripts> .[scriptname].bat
El .\ es opcional desde un símbolo del sistema.
Use un terminal powershell para los scripts de build .ps1.
Desarrolladores MacOS, ejecuten los scripts .bsh desde un terminal MacOS:
…repos/pankosmia/[your-desktop-app-repo-name]/macos/scripts> ./[scriptname].bsh
Desarrolladores Linux, ejecuten los scripts .zsh desde un terminal linux:
…repos/pankosmia/[your-desktop-app-repo-name]/linux/scripts> ./[scriptname].zsh