Redesign planned out
This commit is contained in:
68
specs/003-redesign-you-find/quickstart.md
Normal file
68
specs/003-redesign-you-find/quickstart.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# Quickstart for Redesign - Unisono Application
|
||||
|
||||
This document outlines the steps to quickly set up and run the redesigned Unisono application.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js (LTS) and npm installed
|
||||
- Docker and Docker Compose installed (for backend and full-stack setup)
|
||||
|
||||
## Setup
|
||||
|
||||
1. **Clone the repository**:
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd agree-on-desires
|
||||
git checkout 003-redesign-you-find
|
||||
```
|
||||
|
||||
2. **Backend Setup (if running separately)**:
|
||||
|
||||
Navigate to the `backend` directory and install dependencies:
|
||||
|
||||
```bash
|
||||
cd backend
|
||||
npm install
|
||||
```
|
||||
|
||||
Start the backend service:
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
3. **Frontend Setup**:
|
||||
|
||||
Navigate to the `frontend` directory and install dependencies:
|
||||
|
||||
```bash
|
||||
cd frontend
|
||||
npm install
|
||||
```
|
||||
|
||||
Start the frontend development server:
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
The frontend application should now be accessible in your browser, typically at `http://localhost:3000`.
|
||||
|
||||
4. **Full-stack with Docker Compose (Recommended for local development)**:
|
||||
|
||||
From the project root directory, use Docker Compose to build and run both frontend and backend services:
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
This will set up and start all services as defined in `docker-compose.yaml`. The frontend will be accessible at the configured port (e.g., `http://localhost:80`).
|
||||
|
||||
## Verification
|
||||
|
||||
- Access the application in your web browser.
|
||||
- Verify that the UI is responsive across different screen sizes.
|
||||
- Confirm that the app name "Unisono" and the logo/favicon are displayed correctly.
|
||||
- Check that session topics do not have the "Session: " prefix.
|
||||
- Ensure that input fields do not use placeholders and display validation rules as descriptions.
|
||||
Reference in New Issue
Block a user