diff --git a/README.md b/README.md index f35c089..79d7d74 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,27 @@ -# web-cad - Web-based 2D CAD for Event Seating Plans +# Web CAD -This project is a web-based 2D CAD application for creating event seating plans. +Web-based CAD application for event seating plans. -## Project Structure - -- `frontend/` - React frontend application -- `backend/` - Node.js Fastify backend API - -## Technology Stack - -### Frontend -- React 19 -- TypeScript 5 -- Vite 6 -- ESLint & Prettier -- Vitest for testing - -### Backend -- Node.js 22 -- Fastify 5 -- TypeScript 5 -- SQLite database -- Yjs for collaborative editing -- ESLint & Prettier -- Vitest for testing - -## Development Setup +## Setup 1. Install dependencies: - ```bash + ``` cd frontend && npm install cd ../backend && npm install ``` -2. Start development servers: - ```bash - # In one terminal - cd backend && npm run dev - - # In another terminal +2. Start the development servers: + ``` cd frontend && npm run dev + cd ../backend && npm run dev ``` -## Docker Setup +3. Alternatively, use Docker Compose: + ``` + docker-compose up + ``` -To run the application with Docker: +## Services -```bash -# Build and start services -docker-compose up --build -``` - -This will start: -- Frontend on http://localhost:8080 -- Backend API on http://localhost:3001 -- Backend Docs on http://localhost:3001/docs - -## Testing - -Run tests for both frontend and backend: - -```bash -# Frontend tests -cd frontend && npm test - -# Backend tests -cd backend && npm test -``` \ No newline at end of file +- Frontend: http://localhost:8080 +- Backend: http://localhost:3001 \ No newline at end of file