How churchapps/freeshow works
Project type and purpose
• FreeShow is a full-stack, cross-platform desktop application built on the Electron framework with multiple embedded micro-frontends (Svelte apps) served as HTTP endpoints. It provides slide-show creation/editing, stage display, remote control, camera preview, and output streaming.
File structure
• Top-level “src/electron” folder holds the Electron main process code (business logic, hardware/OS integration, local storage, embedded servers).
• “src/frontend” is the main UI renderer (Svelte).
• “src/server” holds four separate Svelte micro-frontends (cam, controller, remote, stage, output_stream) each with its own HTTP endpoint and static assets.
• Shared modules: “src/common”, “src/types” define cross-cutting types, protocols (protobuf), utilities.
• Config/build scripts for packaging (rollup, vite, snapcraft, electron-builder).
README
• Confirms Electron + Svelte, packaging for Windows/Linux/Mac, features: stage display, remote via browser, cloud sync, NDI, audio/MIDI/OSC integrations.
Main components
a. Electron Host (node.js process)
• Business logic modules (audio, capture, cloud, data, output, NDI, timecode)
• IPC channels (to all renderer processes)
• Embedded HTTP servers for:
– Stage display (src/server/stage)
– Remote control (src/server/remote)
– Camera view (src/server/cam)
– Controller UI (src/server/controller)
– Output stream (src/server/output_stream)
• Local storage (JSON/db) via data modules
• External integrations: OAuth2-based content providers, Google Drive API, ChurchApps sync
• Network I/O: NDI in/out, OSC, WebSockets
b. Renderer processes (Svelte UIs)
– Main desktop UI (src/frontend) communicates over Electron IPC
– Each micro-frontend served by HTTP: stage, remote, cam, controller, output_stream
– External browsers or devices connect to these endpoints (via WebSocket for state updates)
c. External services
– Cloud APIs (PlanningCenter, ChurchApps, Dropbox/Google Drive, Pixabay/Unsplash)
– NDI network devices
– MIDI / OSC hardware
Architectural patterns & design principles
• Client–Server / micro-frontend: multiple independent UIs served by one host
• Event-driven: all modules communicate via IPC or pub/sub (WebSocket)
• Layered separation: UI layer (Svelte), application layer (Electron main), infrastructure layer (OS, network, storage)
• Extensible plugin-style content providers: base class + concrete providers
Relevant technologies/frameworks
• Electron + Node.js + TypeScript
• Svelte (multiple apps)
• Vite & Rollup for bundling
• Protobuf for internal message definitions
• Snapcraft / electron‐builder for packaging
• Playwright for e2e testing