boxlang-runtime-desktop-electron

Automate desktop BoxLang app builds by integrating Electron with a local MiniServer.

16|78|Updated Nov 28, 2014
One-click install
npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-runtime-desktop-electron
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: boxlang-runtime-desktop-electron
Source: https://github.com/ortus-docs/coldbox-docs/tree/main/.agents/skills/boxlang-runtime-desktop-electron
Command: npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-runtime-desktop-electron

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers integrating BoxLang into desktop applications often face fragmented tooling, lifecycle management challenges, and inconsistent runtime packaging across platforms. This skill provides a cohesive pattern that bundles Electron for UI with a local BoxLang MiniServer, standardizing control over startup, readiness, and packaging.

Core Features & Use Cases

  • Modular architecture: bootstrap Electron, manage the MiniServer, and expose a clean frontend-runtime boundary.
  • Packaging workflow: use runtime/Package.bx and miniserver.json to produce portable desktop runtimes with .boxlang.json vs .boxlang-dev.json.
  • Lifecycle orchestration: robust startup/shutdown, readiness probing, and automatic restarts with user notifications.
  • Cross-platform deployment: supports macOS, Windows, and Linux via Electron Forge with strict packaging constraints (asar false, icon requirements).

Quick Start

Start the Electron app to launch the local BoxLang MiniServer and open the UI.

Frequently Asked Questions about boxlang-runtime-desktop-electron

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I package a BoxLang desktop app for cross-platform deployment?

Packaging a BoxLang desktop app involves using runtime/Package.bx with miniserver.json to produce portable runtimes. Electron Forge handles cross-platform deployment across macOS, Windows, and Linux with strict constraints like disabling asar and meeting icon requirements.

What is the best way to manage the lifecycle of a local MiniServer in an Electron app?

Managing a local MiniServer lifecycle in an Electron app requires orchestrating robust startup and shutdown sequences, performing readiness probing, and configuring automatic restarts with user notifications to maintain a clean frontend-runtime boundary.

Can I use Electron Forge to build BoxLang MiniServer applications on Windows and Linux?

Yes, you can use Electron Forge to build BoxLang MiniServer applications on Windows and Linux. The packaging workflow supports cross-platform deployment by enforcing strict constraints including disabling asar packaging and meeting platform-specific icon requirements.

How does the BoxLang MiniServer integrate with Electron for desktop UI?

The BoxLang MiniServer integrates with Electron by bootstrapping a modular architecture that bundles Electron for UI with a local runtime server, exposing a clean frontend-runtime boundary for consistent cross-platform application behavior.

What are the packaging constraints for deploying BoxLang desktop apps with Electron Forge?

Packaging constraints for BoxLang desktop apps with Electron Forge include setting asar to false and meeting platform-specific icon requirements. The workflow uses .boxlang.json and .boxlang-dev.json configuration files to guarantee consistent runtime mappings.

Why does my BoxLang desktop runtime configuration differ between development and production builds?

BoxLang desktop runtime configurations differ between builds because the packaging workflow applies distinct default runtime mappings using .boxlang-dev.json for development environments and .boxlang.json for production to guarantee consistent cross-platform behavior.