Skip to content

docs: clarify Node.js runtime support and Bun-only hot reload #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
remorses merged 1 commit into from
Oct 8, 2026
Merged

docs: clarify Node.js runtime support and Bun-only hot reload #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/document-node-runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@gpuix/react': patch
---

Document existing Node.js runtime support and distinguish Bun's hot-remount development workflow from normal app startup.

Fixes #84
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,14 @@ render(<App />, { title: 'My App', width: 800, height: 600 })
bun --hot app.tsx
```

Use `bun --hot`, not plain `bun`. A save then remounts React on the same
window instead of opening a second one.
For hot reload during development, use `bun --hot` rather than plain `bun`.
A save then remounts React on the same window instead of opening a second one.

Bun is not required to run the renderer. GPUIX uses Node-API native bindings,
and React apps also run on Node.js, as [`disktree`](./disktree/) does. For
Node.js, compile TSX to JavaScript first or use a Node-compatible TSX loader.
The `--hot` option and same-window hot-remount workflow described below are
Bun-specific; running an app on Node.js does not provide Bun's hot reload.

### 4. Ship a binary

Expand Down
Loading