session start works
This commit is contained in:
53
specs/001-people-tend-to/quickstart.md
Normal file
53
specs/001-people-tend-to/quickstart.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Quickstart Guide
|
||||
|
||||
**Feature**: Anonymous Desire Aggregator
|
||||
**Date**: 2025-10-09
|
||||
|
||||
This guide provides instructions to set up and run the project locally using Docker.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Docker and Docker Compose must be installed on your system.
|
||||
- You must have a Google AI API key for the Gemini model family.
|
||||
|
||||
## Setup
|
||||
|
||||
1. **Clone the Repository**
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd <repository-directory>
|
||||
```
|
||||
|
||||
2. **Configure Environment Variables**
|
||||
|
||||
Create a `.env` file in the `backend/` directory:
|
||||
|
||||
```
|
||||
backend/.env
|
||||
```
|
||||
|
||||
Add your Google AI API key to this file:
|
||||
|
||||
```
|
||||
GEMINI_API_KEY="your_api_key_here"
|
||||
```
|
||||
|
||||
## Running the Application
|
||||
|
||||
1. **Build and Run Containers**
|
||||
|
||||
From the root of the project, run the following command:
|
||||
|
||||
```bash
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
This will build the Docker images for both the frontend and backend services and start them.
|
||||
|
||||
2. **Access the Application**
|
||||
|
||||
- The **frontend** will be available at `http://localhost:3000`.
|
||||
- The **backend** API will be served at `http://localhost:8000`.
|
||||
|
||||
You can now open your web browser to `http://localhost:3000` to use the application.
|
||||
Reference in New Issue
Block a user