From 4cbf90348e100a4b61e0a47cd3e1a2b7b99126b9 Mon Sep 17 00:00:00 2001 From: Louis Knight-Webb Date: Tue, 17 Jun 2025 09:39:03 -0400 Subject: [PATCH] Update readmae --- README.md | 51 ++++++++++++--------------------------------------- 1 file changed, 12 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index c2f54119..fe58c6d7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Bloop +# Mission Control -A full-stack monorepo with Rust backend (Axum) and React/TypeScript frontend. +Orchestration and visualisation over multiple coding agents. ## Project Structure @@ -39,68 +39,41 @@ bloop/ ### Installation +1. Install Postgres + +2. Configure .env (see template in backend/.env.example) + +3. Install dependencies + ```bash # Install dependencies -pnpm install - -# Install cargo-watch for backend development -cargo install cargo-watch +npm install ``` ### Development ```bash # Run both frontend and backend in development mode -pnpm dev - -# Or run them separately: -pnpm backend:dev # Runs on http://localhost:3001 -pnpm frontend:dev # Runs on http://localhost:3000 -``` - -### Building - -```bash -# Build both frontend and backend for production -pnpm build - -# Or build them separately: -pnpm frontend:build -pnpm backend:build +npm dev ``` ## Tech Stack ### Backend + - **Rust** with **Axum** web framework - **Tokio** async runtime - **Tower** middleware - **Serde** for JSON serialization ### Frontend + - **React 18** with **TypeScript** - **Vite** for build tooling - **Tailwind CSS** for styling - **shadcn/ui** component library - **Radix UI** primitives -## API Endpoints - -- `GET /` - API root -- `GET /health` - Health check -- `GET /hello?name=` - Hello endpoint -- `POST /echo` - Echo JSON payload - -The frontend proxies `/api/*` requests to the backend during development. - -## Development Scripts - -- `pnpm dev` - Start both frontend and backend in development -- `pnpm build` - Build both for production -- `pnpm frontend:dev` - Start only frontend -- `pnpm backend:dev` - Start only backend with hot reload -- `pnpm backend:run` - Run backend without hot reload - ## Adding shadcn/ui Components ```bash