LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-11-29 16:43:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

added some info about the stack and install instructions to Readme documentation

Browse Source
This commit is contained in:
ethan_h
2023-06-29 13:17:59 +09:00
parent 2f1c3075a2
commit 049c1ddb48
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -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
@@ -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