How automattic/studio works
Project type and purpose
• This is a desktop application built on Electron (Node.js + Chromium) with a React/TypeScript renderer and a companion CLI tool.
• Purpose: allow developers to spin up local WordPress environments, manage sites, snapshots, imports/exports, and connect to WordPress.com/Playground.
Main architectural components
A. Electron-based Desktop App
1. Main Process (Node.js)
– Files: src/main-window.ts, src/menu.ts, src/site-server.ts, src/ipc-handlers.ts, lib/…
– Responsibilities:
• Orchestrate local WordPress server processes (PHP + WP-CLI child processes)
• Manage file system (import/export, snapshots)
• Host a built-in proxy server for preview sites
• Handle IPC requests from the renderer
• Read/write user data (src/storage, JSON/SQLite)
2. Preload Script
– File: src/preload.ts
– Exposes a safe IPC bridge (window.api) to the renderer
3. Renderer Process (React + Redux + Hooks)
– Files under src/components, src/hooks, src/stores
– Responsibilities:
• Present the UI (site list, settings, snapshot manager, previews, “what’s new” modal)
• Dispatch IPC calls via the preload bridge
• Manage local state/slices and caching layers (Redux slices, offline checks)
B. Shared Libraries & Modules
– common/lib, src/lib, src/modules
– Provide utilities (fs-utils, OAuth, locale, sanitization), import/export workflows, preview-site module, site-settings & user-settings modules
C. CLI Tool
– Directory: cli/
– Entry: cli/index.ts, bin/studio-cli.sh/.bat
– Implements “studio preview create/list/delete/update” commands, uses cli/lib/api.ts to talk to WordPress.com APIs
– Shares common/lib code via workspace linking
D. External Services
– WordPress.com REST API (wpcom-api.ts in src/stores)
– WordPress Playground for sandboxed environments
– OAuth endpoints (common/lib/oauth, src/lib/oauth)
E. Packaging & CI/CD
– Build scripts: .buildkite/, fastlane/, scripts/*.mjs
– Outputs: macOS .dmg/.appx, Windows installers, bundled Electron binary
Relationships & data flows
• Main → Child Processes: spawn of local PHP + WP-CLI (site provisioning, import/export)
• Main ↔ Local Storage: read/write JSON or SQLite via storage/user-data.ts
• Main ↔ Proxy Server: intercept preview site traffic
• CLI → External APIs: HTTP calls to WordPress.com, returns JSON
• Renderer ↔ Redux Slices: local data access, offline caching, live UI updates
Key architectural patterns & design principles
– Electron multi-process model: strict separation of UI (renderer) and OS-level operations (main)
– Module decomposition: domain-specific modules (preview-site, site-settings, user-settings)
– Shared utility libraries: DRY approach across CLI and Desktop
– Import/export pipeline: event-driven workflow managers, pluggable importers/exporters
– Redux for state management + React hooks for UI logic
• Labels for each component (e.g., “Electron Main Process”, “React Renderer Process”, “CLI Executable”)
• Callouts for key framework/tech (Electron, React/TSX, Redux slices, Node.js child_process, SQLite/JSON, Fastlane/Buildkite)