Skip to content

Commit

Permalink
Update README.md with instructions to run it locally
Browse files Browse the repository at this point in the history
  • Loading branch information
mpuig committed Jul 9, 2023
1 parent 4664acc commit 6985d75
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,29 @@ possible to run semantic searches through it.
Given a query, RentaGPT fetches relevant information from the database, and then it prompts OpenAI GPT-3 API to generate
an answer from the more relevant documents found in the initial step.

## How to run it locally

First build the `index.html` from the `frontend` directory

```bash
cd frontend
npm install && npm run build
cp dist/index.html ../src/templates
```

Move to the project root, create a copy of the env file

```bash
cd ..
cp .env.template .env
```

Fill in the `.env` file with your credentials and run the project

```bash
uvicorn src.main:app --env-file .env
```

## How to deploy to fly.io

Create an account to [fly.io](https://fly.io)
Expand Down

0 comments on commit 6985d75

Please sign in to comment.