Skip to content

Commit

Permalink
feat: basic execution description
Browse files Browse the repository at this point in the history
  • Loading branch information
Antonwy committed Jul 14, 2024
1 parent 44a7389 commit a482923
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,47 @@

## Problem Statement

## Execution

### Docker Compose
The simplest way to run the application is to use `docker-compose`. This will start the frontend and backend services in separate containers.

**Requirements:**
- Docker

```bash
docker-compose up
```

The frontend will be available at `http://localhost:3001` and the backend will be available at `http://localhost:3002`.

### Manual Setup
If you prefer to run the frontend and backend services manually, you can follow the instructions below.

**Requirements:**
- Node.js
- Yarn
- Python 3.8
- Poetry

#### Frontend
```bash
cd frontend
yarn install
yarn dev
```

#### Backend
```bash
cd backend
poetry install
poetry run python -m lens_gpt_backend.main
```

#### Frontend

#### Backend

## Technical Background

### Frontend
Expand Down

0 comments on commit a482923

Please sign in to comment.