Skip to content

Commit dd34050

Browse files
a-effortjonpspri
authored andcommitted
docs: document Admin UI build step for contributors
Add the required `make build-ui` (or `npm ci && npm run vite:build`) step to README.md, AGENTS.md, and docs/docs/development/building.md so contributors know to build the Admin UI bundle after cloning. Signed-off-by: Anna Effort <anna.effort@datastax.com> Signed-off-by: Mihai Criveti <crivetimihai@gmail.com>
1 parent 7fe3b1e commit dd34050

3 files changed

Lines changed: 26 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ llms/ # End-user LLM guidance (not for code agents)
4848
```bash
4949
cp .env.example .env && make install-dev check-env # Complete setup
5050
make venv # Create virtual environment with uv
51-
make install-dev # Install with dev dependencies
51+
make install-dev # Install with dev dependencies (includes build-ui)
5252
make check-env # Verify .env against .env.example
53+
make build-ui # Rebuild Admin UI JS bundle (requires npm)
5354
```
5455

5556
### Development

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,7 @@ For detailed setup, workflows, and GitHub Codespaces instructions, see **[Develo
655655
## Installation
656656

657657
```bash
658-
make venv install # create .venv + install deps
658+
make venv install-dev # create .venv + install deps + build Admin UI
659659
make serve # gunicorn on :4444
660660
```
661661

docs/docs/development/building.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,29 @@ The Admin UI uses plain JavaScript (not TypeScript). Frontend tooling requires N
101101
npm install # install frontend dev dependencies
102102
```
103103

104+
### Building the Admin UI Bundle
105+
106+
The Admin UI JavaScript is bundled with Vite. The bundle is not committed to the repository — it is built locally during `make install-dev` (which calls `make build-ui`). Rebuild after any changes to files under `mcpgateway/admin_ui/`.
107+
108+
```bash
109+
make build-ui # build mcpgateway/static/bundle-<hash>.js (requires npm)
110+
```
111+
112+
Or manually:
113+
114+
```bash
115+
npm ci # install dependencies from lockfile (if not already done)
116+
npm run vite:build # produce mcpgateway/static/bundle-<hash>.js
117+
```
118+
119+
The server reads `mcpgateway/static/.vite/manifest.json` at startup to locate the hashed bundle filename.
120+
121+
For iterative development you can use watch mode:
122+
123+
```bash
124+
npx vite build --watch
125+
```
126+
104127
### Linting & Formatting
105128

106129
```bash

0 commit comments

Comments
 (0)