How openblockcc/openblock-desktop works
Project Type & Purpose
• This is a full‑stack desktop application built on Electron. It has two runtime processes (a Node.js “main” process and a Chromium “renderer” process), plus a build/packaging pipeline driven by webpack, electron-builder, and helper scripts.
• Top‑level build & config:
• webpack.main.js, webpack.renderer.js, webpack.makeConfig.js
• scripts/ (download drivers, post‑sign hooks, builder wrappers)
• Runtime code:
• src/main/ – all main‑process modules (index, argv, FileFilters, MacOSMenu, Updater, TelemetryClient)
• src/renderer/ – React UI code (app.jsx, HOCs, individual pages, CSS, index.html)
• src/common/ – shared utilities (ElectronStorageHelper, logging)
• Dev and CI:
• .github/workflows/ – build & release, build test app
• .eslintrc.js, .editorconfig, package.json
README for Architectural Clues
• Confirms Electron + React stack
• Mentions distribution via GitHub Actions & electron-builder
• Screenshots in doc/ suggest two GUI states (loading, app, about, license, privacy)
a. Build & Packaging Pipeline
• Source files → webpack (main + renderer) → electron-builder → platform‑specific installers (buildResources → packaged output)
• Helper scripts invoked before/after signing or to fetch driver assets
b. Electron Main Process (src/main)
• Entry: argv.js → index.js
• Modules: FileFilters, MacOSMenu, OpenblockDesktopLink, Updater, TelemetryClient
• Communicates with file system (via ElectronStorageHelper) and external services (update server, telemetry endpoint)
• Listens on IPC channels for UI requests
c. Electron Renderer Process (src/renderer)
• React components wrapped by HOCs (ScratchDesktopAppStateHOC, ScratchDesktopGUIHOC)
• Pages: loading, about, license, privacy, main app
• Sends/receives IPC messages to main process
d. Shared/Common Modules (src/common)
• Logging (log.js)
• Storage helper for persistent settings/data
e. External Services & Data Stores
• Telemetry server (HTTPS)
• Auto‑update server (HTTPS)
Architectural Patterns & Design Principles
• Process separation: main vs renderer → clear security/sandbox boundary
• HOCs in React promote code reuse (state, telemetry instrumentation)
• Modular services in main process (updater, telemetry)