Update readmae
This commit is contained in:
51
README.md
51
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
|
## Project Structure
|
||||||
|
|
||||||
@@ -39,68 +39,41 @@ bloop/
|
|||||||
|
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
|
1. Install Postgres
|
||||||
|
|
||||||
|
2. Configure .env (see template in backend/.env.example)
|
||||||
|
|
||||||
|
3. Install dependencies
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install dependencies
|
# Install dependencies
|
||||||
pnpm install
|
npm install
|
||||||
|
|
||||||
# Install cargo-watch for backend development
|
|
||||||
cargo install cargo-watch
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Development
|
### Development
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Run both frontend and backend in development mode
|
# Run both frontend and backend in development mode
|
||||||
pnpm dev
|
npm 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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
### Backend
|
### Backend
|
||||||
|
|
||||||
- **Rust** with **Axum** web framework
|
- **Rust** with **Axum** web framework
|
||||||
- **Tokio** async runtime
|
- **Tokio** async runtime
|
||||||
- **Tower** middleware
|
- **Tower** middleware
|
||||||
- **Serde** for JSON serialization
|
- **Serde** for JSON serialization
|
||||||
|
|
||||||
### Frontend
|
### Frontend
|
||||||
|
|
||||||
- **React 18** with **TypeScript**
|
- **React 18** with **TypeScript**
|
||||||
- **Vite** for build tooling
|
- **Vite** for build tooling
|
||||||
- **Tailwind CSS** for styling
|
- **Tailwind CSS** for styling
|
||||||
- **shadcn/ui** component library
|
- **shadcn/ui** component library
|
||||||
- **Radix UI** primitives
|
- **Radix UI** primitives
|
||||||
|
|
||||||
## API Endpoints
|
|
||||||
|
|
||||||
- `GET /` - API root
|
|
||||||
- `GET /health` - Health check
|
|
||||||
- `GET /hello?name=<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
|
## Adding shadcn/ui Components
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
Reference in New Issue
Block a user