rowboat/apps/rowboatx/README.md

39 lines
1.2 KiB
Markdown
Raw Normal View History

# RowboatX Frontend
2025-12-10 23:48:19 +05:30
`apps/rowboatx` is the newer frontend for the local Rowboat runtime. It is a Next.js UI that renders chat, artifacts, tools, and resource views on top of a runtime provided by `apps/cli` or another host shell.
2025-12-10 23:48:19 +05:30
## What Lives Here
2025-12-10 23:48:19 +05:30
- Main chat/dashboard page in `app/page.tsx`
- Shared UI primitives and AI-oriented components under `components/`
- Static export configuration in `next.config.ts`
2025-12-10 23:48:19 +05:30
## Runtime Expectations
2025-12-10 23:48:19 +05:30
This frontend is not self-contained. It expects one of the following to exist at runtime:
2025-12-10 23:48:19 +05:30
- `window.config.apiBase` for direct backend requests
- `/api/stream` for SSE run events
- `/api/rowboat/*` endpoints for local resource browsing and editing
2025-12-10 23:48:19 +05:30
In practice, this means the UI is meant to be served by a shell or proxy that also provides the local runtime APIs.
2025-12-10 23:48:19 +05:30
## Local Development
2025-12-10 23:48:19 +05:30
```bash
npm install
npm run dev
```
2025-12-10 23:48:19 +05:30
Build the static export:
2025-12-10 23:48:19 +05:30
```bash
npm run build
```
2025-12-10 23:48:19 +05:30
## Notes For Contributors
2025-12-10 23:48:19 +05:30
- Changes here should preserve the assumption that the backend lives outside this app.
- If you add a new runtime endpoint, document the expected contract in the host surface that provides it.
- For repo-level ownership and status, see the root `ARCHITECTURE.md`.