UI Readme

This commit is contained in:
Shantur Rathore
2025-11-21 12:40:49 +00:00
parent b6d48bfb69
commit 881afbba0a

33
packages/ui/README.md Normal file
View File

@@ -0,0 +1,33 @@
# CodeNomad UI
This package contains the frontend user interface for CodeNomad, built with [SolidJS](https://www.solidjs.com/) and [Tailwind CSS](https://tailwindcss.com/).
## Overview
The UI is designed to be a high-performance, low-latency cockpit for managing OpenCode sessions. It connects to the CodeNomad server (either running locally via CLI or embedded in the Electron app).
## Features
- **SolidJS**: Fine-grained reactivity for high performance.
- **Tailwind CSS**: Utility-first styling for rapid development.
- **Vite**: Fast build tool and dev server.
## Development
To run the UI in standalone mode (connected to a running server):
```bash
npm run dev
```
This starts the Vite dev server at `http://localhost:3000`.
## Building
To build the production assets:
```bash
npm run build
```
The output will be generated in the `dist` directory, which is then consumed by the Server or Electron app.