Thanks for your interest in contributing to SimOffice! This guide will help you get started.
- Node.js 22.14+
- pnpm 10+
- macOS 12+ (Electron desktop app)
git clone https://github.com/johnkf5-ops/simoffice.git
cd simoffice
pnpm install
pnpm develectron/
main/ # Electron main process (app lifecycle, IPC handlers, updater)
utils/ # Main process utilities (auth, paths, config, OAuth)
gateway/ # OpenClaw gateway manager and config sync
api/ # Host API server (REST routes for renderer)
services/ # Provider services (runtime sync, provider management)
preload/ # Preload scripts (IPC bridge to renderer)
src/
components/ # React components (UI, settings, channels, providers)
pages/ # Route pages (Lobby, Chat, Connections, Analytics, etc.)
stores/ # Zustand state stores
lib/ # Shared libraries (API client, gateway client, providers)
features/ # Feature modules (office, agents)
i18n/ # Internationalization (en, ja, zh)
scripts/ # Build scripts (bundle-openclaw, bundle-plugins, etc.)
resources/ # App icons, platform binaries, CLI scripts
- All colors use CSS variables. Never hardcode colors — light and dark themes are both supported.
- State management uses Zustand. Each store is a single file in
src/stores/. - Chat store is a monolith —
src/stores/chat.tsis the single source of truth for all chat logic. - Rooms are frontend-only. Room messages live in the rooms store, not the chat store.
- OpenClaw is bundled — the gateway runs as a child process managed by
electron/gateway/manager.ts. - Native deps must be explicit — pnpm hoisting means transitive runtime deps need to be in
package.json.
- Fork the repo and create a feature branch from
main - Make your changes
- Run
pnpm testandpnpm typecheckto verify nothing is broken - Open a pull request with a clear description of the change
Open a GitHub Issue with:
- Steps to reproduce
- Expected vs actual behavior
- macOS version and chip (Intel/Apple Silicon)
- SimOffice version (Settings page)
This project follows the Contributor Covenant Code of Conduct. Please read it before participating.
By contributing, you agree that your contributions will be licensed under the same proprietary license as the project.