blob: b904934bc60334a3f0c707718e93969164739b83 [file] [log] [blame] [view]
Earl Lee2e463fb2025-04-17 11:22:22 -07001# Loop WebUI
2
3A modern web interface for the CodingAgent loop.
4
5The server in the sibling directory (../server) exposes an HTTP API for
6the CodingAgent.
7
8## Development
9
10This module contains a TypeScript-based web UI for the Loop service. The TypeScript code is compiled into JavaScript using esbuild, and the resulting bundle is served by the Go server.
11
12### Prerequisites
13
14- Node.js and npm
15- Go 1.20 or later
16
17### Setup
18
19```bash
20# Install dependencies
21make install
22
23# Build the TypeScript code
24make build
25
26# Type checking only
27make check
28```
29
30### Development Mode
31
32For development, you can use watch mode:
33
34```bash
35make dev
36```
37
38This will rebuild the TypeScript files whenever they change.
39
40## Integration with Go Server
41
42The TypeScript code is bundled into JavaScript using esbuild and then served by the Go HTTP server. The integration happens through the `webui` package, which provides a function to retrieve the built bundle.
43
44The server code accesses the built web UI through the `webui.GetBundle()` function, which returns a filesystem that can be used to serve the files.
45
46## File Structure
47
48- `src/`: TypeScript source files
49- `dist/`: Generated JavaScript bundle
50- `esbuild.go`: Go code for bundling TypeScript files
51- `Makefile`: Build tasks
Sean McCullough86b56862025-04-18 13:04:03 -070052
53## Bundle Analysis
54
55You can analyze the size and dependency structure of the TypeScript bundles:
56
57```bash
58# Generate bundle metafiles in a temporary directory
59go run sketch.dev/cmd/bundle-analyzer
60```
61
62The tool generates metafiles that can be analyzed by dragging them onto the esbuild analyzer at https://esbuild.github.io/analyze/