Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added some missing info on the Readme #274

Merged
merged 1 commit into from
Jun 29, 2023
Merged

Added some missing info on the Readme #274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
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