mirror of
https://github.com/Pandipipas/scoreko-electron-dev.git
synced 2026-06-05 21:22:07 +00:00
Translate Spanish text to English across docs and code
This commit is contained in:
@@ -1,20 +1,20 @@
|
||||
# scoreko-electron-dev
|
||||
|
||||
Wrapper de Electron para empaquetar una instalación de NodeCG que incluya el bundle `scoreko-dev`, inspirado en `opeik/runback-electron` pero actualizado a Electron + TypeScript moderno.
|
||||
Electron wrapper to package a NodeCG installation that includes the `scoreko-dev` bundle, inspired by `opeik/runback-electron` but updated to modern Electron + TypeScript.
|
||||
|
||||
## Requisitos clave
|
||||
## Key requirements
|
||||
|
||||
- Node `>=22` (`.nvmrc` incluido).
|
||||
- Electron fijado en `39.5.1`.
|
||||
- Node `>=22` (`.nvmrc` included).
|
||||
- Electron pinned to `39.5.1`.
|
||||
|
||||
## Qué hace
|
||||
## What it does
|
||||
|
||||
- Arranca `lib/nodecg/index.js` como proceso hijo desde Electron.
|
||||
- Muestra la ruta de dashboard de carga del bundle (`/bundles/<bundle>/dashboard/loading.html`) servida por NodeCG mientras inicia.
|
||||
- Carga el dashboard del bundle en `http://localhost:<puerto>/bundles/<bundle>/<ruta-dashboard>`.
|
||||
- Empaqueta NodeCG + assets dentro de la app final con `electron-builder`.
|
||||
- Starts `lib/nodecg/index.js` as a child process from Electron.
|
||||
- Shows the bundle loading dashboard route (`/bundles/<bundle>/dashboard/loading.html`) served by NodeCG while it starts.
|
||||
- Loads the bundle dashboard at `http://localhost:<port>/bundles/<bundle>/<dashboard-route>`.
|
||||
- Packages NodeCG + assets inside the final app with `electron-builder`.
|
||||
|
||||
## Estructura esperada
|
||||
## Expected structure
|
||||
|
||||
```text
|
||||
scoreko-electron-dev/
|
||||
@@ -31,34 +31,34 @@ scoreko-electron-dev/
|
||||
|
||||
## Scripts
|
||||
|
||||
- `npm run dev`: modo desarrollo.
|
||||
- `npm run build`: compila TypeScript y copia assets.
|
||||
- `npm run start`: build y ejecución local.
|
||||
- `npm run test`: build + tests unitarios (`node:test`).
|
||||
- `npm run doctor`: preflight de configuración y entorno (`lib/nodecg`, permisos, puerto y env vars).
|
||||
- `npm run lint`: reglas mínimas de calidad con ESLint.
|
||||
- `npm run format`: validación de formato con Prettier.
|
||||
- `npm run pack`: genera app sin instalador.
|
||||
- `npm run dist`: genera instalador.
|
||||
- `npm run dev`: development mode.
|
||||
- `npm run build`: compile TypeScript and copy assets.
|
||||
- `npm run start`: build and local run.
|
||||
- `npm run test`: build + unit tests (`node:test`).
|
||||
- `npm run doctor`: configuration/environment preflight (`lib/nodecg`, permissions, port, and env vars).
|
||||
- `npm run lint`: minimal quality rules with ESLint.
|
||||
- `npm run format`: format validation with Prettier.
|
||||
- `npm run pack`: generate app without installer.
|
||||
- `npm run dist`: generate installer.
|
||||
|
||||
## Variables de entorno
|
||||
## Environment variables
|
||||
|
||||
La **fuente única de defaults** está en `.env.example`.
|
||||
The **single source of truth for defaults** is in `.env.example`.
|
||||
|
||||
1. Copia `.env.example` a `.env` (o exporta variables en tu shell/CI).
|
||||
2. Ajusta sólo lo necesario.
|
||||
3. Ejecuta `npm run doctor` para validar configuración antes de arrancar.
|
||||
1. Copy `.env.example` to `.env` (or export variables in your shell/CI).
|
||||
2. Adjust only what you need.
|
||||
3. Run `npm run doctor` to validate configuration before starting.
|
||||
|
||||
## Build multi-plataforma (iconos)
|
||||
## Cross-platform build (icons)
|
||||
|
||||
- `build.win.icon`: `static/icons/icon.ico`
|
||||
- `build.linux.icon`: `static/icons`
|
||||
- `build.mac.icon`: `static/icons/icon.icns`
|
||||
|
||||
> El `.icns` se referencia en la configuración de build y debe existir localmente para empaquetar macOS.
|
||||
> The `.icns` is referenced in build config and must exist locally to package macOS.
|
||||
|
||||
## Troubleshooting y arquitectura
|
||||
## Troubleshooting and architecture
|
||||
|
||||
- Guía de troubleshooting: `docs/troubleshooting.md`
|
||||
- Mapa de arquitectura: `docs/architecture.md`
|
||||
- Troubleshooting guide: `docs/troubleshooting.md`
|
||||
- Architecture map: `docs/architecture.md`
|
||||
- Roadmap: `docs/refactor-roadmap.md`
|
||||
|
||||
Reference in New Issue
Block a user