Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-08 01:10:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
623 Commits 43 Branches 12 Tags 95 MiB
Python 51.2%
TypeScript 43.4%
JavaScript 1.6%
CSS 1.5%
Shell 0.9%
Other 1.4%
8187a339f0
Go to file
Alex 8187a339f0 little bug fix
2023-07-26 22:17:18 +01:00
.github/workflows Update sync_fork.yaml 2023-06-30 07:26:50 +07:00
application history 2023-07-26 22:14:54 +01:00
extensions Fixed request length bug, changed to as less used port 2023-06-23 14:56:14 +03:00
frontend little bug fix 2023-07-26 22:17:18 +01:00
scripts Bump cryptography from 41.0.0 to 41.0.2 in /scripts 2023-07-15 15:21:20 +00:00
.env-template Changed environment variable names OPENAI_API_BASE and OPENAI_API_VERSION to AZURE_OPENAI_API_BASE and AZURE_OPENAI_API_VERSION 2023-07-12 17:37:56 +02: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 Changed environment variable names OPENAI_API_BASE and OPENAI_API_VERSION to AZURE_OPENAI_API_BASE and AZURE_OPENAI_API_VERSION 2023-07-12 17:37:56 +02:00
docker-compose-dev.yaml Added dev docker compose file 2023-04-26 19:05:50 +01:00
docker-compose.yaml Fixed request length bug, changed to as less used port 2023-06-23 14:56:14 +03: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 added some info about the stack and install instructions to Readme documentation 2023-06-29 13:17:59 +09:00
run-with-docker-compose.sh Changed environment variable names OPENAI_API_BASE and OPENAI_API_VERSION to AZURE_OPENAI_API_BASE and AZURE_OPENAI_API_VERSION 2023-07-12 17:37:56 +02:00
setup.sh Fixed request length bug, changed to as less used port 2023-06-23 14:56:14 +03: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 uses Vite and React

QuickStart

Note: Make sure you have docker installed

  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
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 or higher.

  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