webui/README.md
This directory contains the React/TypeScript source for the nanobot WebUI. If
you installed nanobot-ai from PyPI and only want to use the bundled browser UI,
read the user guide in docs/webui.md. You do not need
Node.js, Bun, Vite, or anything in this directory unless you are changing the
frontend.
For the project overview, install guide, and general docs map, see the root README.md and docs/README.md.
| Goal | Start with | Opens at |
|---|---|---|
| Use the bundled browser UI | docs/webui.md | http://127.0.0.1:8765 |
| Use the WebUI from another device | docs/webui.md#lan-access | http://<your-ip>:8765 |
| Change WebUI source code | Develop the WebUI (Vite HMR) | http://127.0.0.1:5173 |
| Debug setup failures | docs/troubleshooting.md#webui-problems | Diagnosis order and common fixes |
The source app is built with Vite + React 18 + TypeScript + Tailwind 3 + shadcn/ui. It talks to the gateway over the WebSocket multiplex protocol and reads session metadata from the embedded REST surface on the same port.
webui/ source tree (this directory)
nanobot/web/dist/ build output served by the gateway
From the repository root:
python -m pip install -e .
Editable installs intentionally skip the WebUI bundle step — Vite HMR is faster than rebuilding
dist/on every change.
In ~/.nanobot/config.json, merge:
{ "channels": { "websocket": { "enabled": true } } }
In one terminal:
nanobot gateway
In another terminal:
cd webui
bun install # npm install also works
bun run dev
Then open http://127.0.0.1:5173.
By default the dev server proxies /api, /webui, /auth, and WebSocket traffic to http://127.0.0.1:8765.
If your gateway listens on a non-default port, point the dev server at it:
NANOBOT_API_URL=http://127.0.0.1:9000 bun run dev
You usually do not need to run this by hand: python -m build invokes the WebUI build automatically when packaging the wheel.
If you want to preview the production bundle locally without rebuilding the wheel:
cd webui
bun run build # writes to ../nanobot/web/dist
The gateway picks up the new bundle on the next restart.
cd webui
bun run test
agent-chat-ui for UI and interaction inspiration across the chat surface.