docs: add web frontend usage

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
tao.chen
2026-07-02 19:38:19 +08:00
co-authored by Claude
parent 062cde88f8
commit b5fababeea
2 changed files with 37 additions and 1 deletions
+36
View File
@@ -0,0 +1,36 @@
# codespace-web
Frontend IDE shell for the codespace Go backend.
## Scope
This package is a runnable **UI scaffold only**. It provides the workspace layout, a mock file explorer, a Monaco editor wrapper, and an xterm terminal wrapper. It does not yet connect to the Go API.
## Commands
| Command | Purpose |
|---|---|
| `pnpm install` | Install dependencies |
| `pnpm dev` | Start the Vite dev server |
| `pnpm lint` | Run ESLint |
| `pnpm build` | Type-check and build for production |
## Stack
- Vite + React 19 + TypeScript
- Tailwind CSS v4
- react-router v7
- Zustand for local UI state
- TanStack Query (provider only; no real API calls yet)
- `@monaco-editor/react` editor wrapper
- `@xterm/xterm` + `@xterm/addon-fit` terminal wrapper
- `react-resizable-panels` for layout splits
- `lucide-react` for icons
## Non-goals
- Backend API integration (reserved file only at `src/lib/api/client.ts`)
- Authentication
- WebSocket terminal or process streaming
- i18n
- Tests (no test framework until business logic is added)