hermes / web /README.md
haochengsama's picture
Add files using upload-large-folder tool
be4122e verified
|
Raw
History Blame Contribute Delete
1.51 kB
# Hermes Agent β€” Web UI
Browser-based dashboard for managing Hermes Agent configuration, API keys, and monitoring active sessions.
## Stack
- **Vite** + **React 19** + **TypeScript**
- **Tailwind CSS v4** with custom dark theme
- **shadcn/ui**-style components (hand-rolled, no CLI dependency)
## Development
```bash
# Start the backend API server
cd ../
python -m hermes_cli.main web --no-open
# In another terminal, start the Vite dev server (with HMR + API proxy)
cd web/
npm run dev
```
The Vite dev server proxies `/api` requests to `http://127.0.0.1:9119` (the FastAPI backend).
## Build
```bash
npm run build
```
This outputs to `../hermes_cli/web_dist/`, which the FastAPI server serves as a static SPA. The built assets are included in the Python package via `pyproject.toml` package-data.
## Structure
```
src/
β”œβ”€β”€ components/ui/ # Reusable UI primitives (Card, Badge, Button, Input, etc.)
β”œβ”€β”€ lib/
β”‚ β”œβ”€β”€ api.ts # API client β€” typed fetch wrappers for all backend endpoints
β”‚ └── utils.ts # cn() helper for Tailwind class merging
β”œβ”€β”€ pages/
β”‚ β”œβ”€β”€ StatusPage # Agent status, active/recent sessions
β”‚ β”œβ”€β”€ ConfigPage # Dynamic config editor (reads schema from backend)
β”‚ └── EnvPage # API key management with save/clear
β”œβ”€β”€ App.tsx # Main layout and navigation
β”œβ”€β”€ main.tsx # React entry point
└── index.css # Tailwind imports and theme variables
```