mirror of
https://github.com/arc53/DocsGPT
synced 2024-11-17 21:26:26 +00:00
115 lines
4.1 KiB
Markdown
115 lines
4.1 KiB
Markdown
<h1 align="center">
|
|
DocsGPT 🦖
|
|
</h1>
|
|
|
|
<p align="center">
|
|
<strong>Open-Source Documentation Assistant</strong>
|
|
</p>
|
|
|
|
<p align="left">
|
|
<strong>DocsGPT</strong> is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful <strong>GPT</strong> models, developers can easily ask questions about a project and receive accurate answers.
|
|
|
|
Say goodbye to time-consuming manual searches, and let <strong>DocsGPT</strong> help you quickly find the information you need. Try it out and see how it revolutionizes your project documentation experience. Contribute to its development and be a part of the future of AI-powered assistance.
|
|
</p>
|
|
|
|
<div align="center">
|
|
|
|
<a href="https://discord.gg/n5BX8dh8rU"></a>
|
|
<a href="https://discord.gg/n5BX8dh8rU"></a>
|
|
<a href="https://discord.gg/n5BX8dh8rU"></a>
|
|
<a href="https://discord.gg/n5BX8dh8rU"></a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
## Our Livestream coming up on 17th of June at 6pm UK time
|
|
[DocsGPT Live: Gen AI in business and Fine tuning models](https://discord.gg/pbCTxb8z?event=1117425466681335808)
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
|
|
## Roadmap
|
|
|
|
You can find our [Roadmap](https://github.com/orgs/arc53/projects/2) here, please don't hesitate contributing or creating issues, it helps us make DocsGPT better!
|
|
|
|
|
|
|
|
## [Live preview](https://docsgpt.arc53.com/)
|
|
|
|
## [Join Our Discord](https://discord.gg/n5BX8dh8rU)
|
|
|
|
|
|
## Project structure
|
|
- Application - flask app (main application)
|
|
|
|
- Extensions - chrome extension
|
|
|
|
- Scripts - script that creates similarity search index and store for other libraries.
|
|
|
|
- frontend - frontend in vite and
|
|
|
|
## 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
|
|
|
|
```
|
|
OPENAI_API_KEY=Yourkey
|
|
VITE_API_STREAMING=true
|
|
```
|
|
3. Run `docker-compose build && docker-compose up`
|
|
4. Navigate to http://localhost:5173/
|
|
|
|
To stop just run Ctrl + C
|
|
|
|
## Development environments
|
|
|
|
Spin up only 2 containers from docker-compose.yaml (by deleting all services except for redis and mongo)
|
|
|
|
Make sure you have python 3.10 or 3.11 installed
|
|
|
|
1. Navigate to `/application` folder
|
|
2. Run `docker-compose -f docker-compose-dev.yaml build && docker-compose -f docker-compose-dev.yaml up -d`
|
|
3. Export required variables
|
|
`export CELERY_BROKER_URL=redis://localhost:6379/0`
|
|
`export CELERY_RESULT_BACKEND=redis://localhost:6379/1`
|
|
`export MONGO_URI=mongodb://localhost:27017/docsgpt`
|
|
4. Install dependencies
|
|
`pip install -r requirements.txt`
|
|
5. Prepare .env file
|
|
Copy .env_sample and create .env with your openai api token
|
|
6. Run the app
|
|
`python wsgi.py`
|
|
7. Start worker with `celery -A app.celery worker -l INFO`
|
|
|
|
To start frontend
|
|
1. Navigate to `/frontend` folder
|
|
2. Install dependencies
|
|
`npm install`
|
|
3. Run the app
|
|
4. `npm run dev`
|
|
|
|
|
|
[How to install the Chrome extension](https://github.com/arc53/docsgpt/wiki#launch-chrome-extension)
|
|
|
|
|
|
## [Guides](https://github.com/arc53/docsgpt/wiki)
|
|
|
|
## [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
|
|
|
|
## [How to use any other documentation](https://github.com/arc53/docsgpt/wiki/How-to-train-on-other-documentation)
|
|
|
|
## [How to host it locally (so all data will stay on-premises)](https://github.com/arc53/DocsGPT/wiki/How-to-use-different-LLM's#hosting-everything-locally)
|
|
|
|
Built with [🦜️🔗 LangChain](https://github.com/hwchase17/langchain)
|
|
|