Skip to content

Commit

Permalink
Merge pull request #274 from UndrscoreEX/readme_update
Browse files Browse the repository at this point in the history
Added some missing info on the Readme
  • Loading branch information
dartpain authored Jun 29, 2023
2 parents 2f1c307 + 049c1dd commit e26b95a
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,21 @@ You can find our [Roadmap](https://github.com/orgs/arc53/projects/2) here, pleas


## Project structure
- Application - flask app (main application)
- Application - Flask app (main application)

- Extensions - chrome extension
- Extensions - Chrome extension

- Scripts - script that creates similarity search index and store for other libraries.
- Scripts - Script that creates similarity search index and store for other libraries.

- frontend - frontend in vite and
- Frontend - Frontend uses Vite and React

## QuickStart

Note: Make sure you have docker installed

1. Open dowload this repository with `git clone https://github.com/arc53/DocsGPT.git`
2. Create .env file in your root directory and set your OPENAI_API_KEY with your openai api key and VITE_API_STREAMING to true or false if you dont want streaming answers
Should look like this inside
1. Dowload and open this repository with `git clone https://github.com/arc53/DocsGPT.git`
2. Create an .env file in your root directory and set the env variable OPENAI_API_KEY with your openai api key and VITE_API_STREAMING to true or false, depending on if you want streaming answers or not
It should look like this inside:

```
OPENAI_API_KEY=Yourkey
Expand Down Expand Up @@ -107,7 +107,7 @@ pip install -r requirements.txt
6. Start worker with `celery -A app.celery worker -l INFO`

### Start frontend
Make sure you have Node version 16+
Make sure you have Node version 16 or higher.

1. Navigate to `/frontend` folder
2. Install dependencies
Expand Down

1 comment on commit e26b95a

@vercel
Copy link

@vercel vercel bot commented on e26b95a Jun 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs-gpt – ./

docs-gpt-brown.vercel.app
docs-gpt-git-main-arc53.vercel.app
docs-gpt-arc53.vercel.app

Please sign in to comment.