Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-03 23:15:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
588 Commits 42 Branches 12 Tags 94 MiB
Python 51.4%
TypeScript 43.3%
JavaScript 1.6%
CSS 1.5%
Shell 0.9%
Other 1.3%
92373b25a9
Go to file
Alex 92373b25a9
Merge pull request #269 from larinam/main 
Azure implementation for the streaming output
2023-06-18 12:42:53 +01:00
.github/workflows fix workflow: upgrade "build and push" action version to the latest 2023-05-16 08:02:13 +02:00
application fix configuration to support streaming answer with Azure 2023-06-17 17:40:31 +02:00
extensions Linting 2023-05-13 10:36:17 +02:00
frontend fix for sending sources + azure embeddings issue 2023-06-15 11:35:21 +01:00
scripts add missing variable after testin and minor fixes. 2023-06-17 16:09:22 +02:00
.env-template fix for sending sources + azure embeddings issue 2023-06-15 11:35:21 +01:00
.gitignore feat(extension): migrate chrome extension v2 to v3 2023-03-16 13:58:11 +08:00
.ruff.toml Linting 2023-05-13 10:36:17 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2023-02-02 23:13:06 +00:00
CONTRIBUTING.md Create CONTRIBUTING.md 2023-02-14 14:55:41 +00:00
docker-compose-azure.yaml add missing variable after testin and minor fixes. 2023-06-17 16:09:22 +02:00
docker-compose-dev.yaml Added dev docker compose file 2023-04-26 19:05:50 +01:00
docker-compose.yaml running with docker-compose with .sh script for more convenience with Azure. 2023-06-17 13:35:05 +02:00
LICENSE Initial commit 2023-02-02 11:03:24 +00:00
Readme Logo.png Add files via upload 2023-02-05 21:10:42 +03:00
README.md Merge branch 'main' of https://github.com/arc53/DocsGPT 2023-06-18 08:04:04 +00:00
run-with-docker-compose.sh add missing variable after testin and minor fixes. 2023-06-17 16:09:22 +02:00
setup.sh Update setup.sh 2023-04-27 12:39:03 -07:00

README.md

DocsGPT 🦖

Open-Source Documentation Assistant

DocsGPT is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful GPT models, developers can easily ask questions about a project and receive accurate answers.

Say goodbye to time-consuming manual searches, and let DocsGPT 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.

Our recent Livestream

example1 example2 example3 example3

video-example-of-docs-gpt

Features

Group 9

Roadmap

You can find our Roadmap here, please don't hesitate contributing or creating issues, it helps us make DocsGPT better!

DocsGPT-7B Our finetuned model to help you keep your data private, fine-tuned on top on MPT-7b

Live preview

Join Our Discord

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 ./run-with-docker-compose.sh

  4. Navigate to http://localhost:5173/

To stop just run Ctrl + C

Development environments

Spin up mongo and redis

For development only 2 containers are used from docker-compose.yaml (by deleting all services except for redis and mongo). See file docker-compose-dev.yaml.

Run

docker compose -f docker-compose-dev.yaml build
docker compose -f docker-compose-dev.yaml up -d

Run the backend

Make sure you have Python 3.10 or 3.11 installed.

  1. Export required environment variables
export CELERY_BROKER_URL=redis://localhost:6379/0   
export CELERY_RESULT_BACKEND=redis://localhost:6379/1
export MONGO_URI=mongodb://localhost:27017/docsgpt
  1. Prepare .env file Copy .env_sample and create .env with your OpenAI API token
  2. (optional) Create a python virtual environment
python -m venv venv
. venv/bin/activate
  1. Change to application/ subdir and install dependencies for the backend
cd application/ 
pip install -r requirements.txt
  1. Run the app python wsgi.py
  2. Start worker with celery -A app.celery worker -l INFO

Start frontend

Make sure you have Node version 16+

  1. Navigate to /frontend folder
  2. Install dependencies npm install
  3. Run the app npm run dev

How to install the Chrome extension

Guides

Interested in contributing?

How to use any other documentation

How to host it locally (so all data will stay on-premises)

Built with 🦜️🔗 LangChain