diff options
| author | Aiden Cline <[email protected]> | 2026-01-04 09:27:15 -0600 |
|---|---|---|
| committer | Aiden Cline <[email protected]> | 2026-01-04 13:12:43 -0600 |
| commit | 1d54f90330a4f262b306fbeefcdacc204b3112d7 (patch) | |
| tree | 08410d5f04e8a65ec9fe48aa5c7719b355e84579 /CONTRIBUTING.md | |
| parent | 5f10243e91a41fee03f0572e598491293deff79f (diff) | |
| download | opencode-1d54f90330a4f262b306fbeefcdacc204b3112d7.tar.gz opencode-1d54f90330a4f262b306fbeefcdacc204b3112d7.zip | |
docs: add instructions for running web and desktop apps during development
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ee9ae430..b73129b2a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,8 +67,31 @@ Replace `<platform>` with your platform (e.g., `darwin-arm64`, `linux-x64`). - Core pieces: - `packages/opencode`: OpenCode core business logic & server. - `packages/opencode/src/cli/cmd/tui/`: The TUI code, written in SolidJS with [opentui](https://github.com/sst/opentui) + - `packages/app`: The shared web UI components, written in SolidJS + - `packages/desktop`: The native desktop app, built with Tauri (wraps `packages/app`) - `packages/plugin`: Source for `@opencode-ai/plugin` +### Running the Web App + +To test UI changes during development, run the web app: + +```bash +bun run --cwd packages/app dev +``` + +This starts a local dev server at http://localhost:5173 (or similar port shown in output). Most UI changes can be tested here. + +### Running the Desktop App + +The desktop app is a native Tauri application that wraps the web UI. To run it: + +```bash +bun run --cwd packages/desktop dev +``` + +> [!NOTE] +> Running the desktop app requires additional Tauri dependencies (Rust toolchain, platform-specific libraries). See the [Tauri prerequisites](https://v2.tauri.app/start/prerequisites/) for setup instructions. + > [!NOTE] > If you make changes to the API or SDK (e.g. `packages/opencode/src/server/server.ts`), run `./script/generate.ts` to regenerate the SDK and related files. |