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
544 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%
610adcbefc
Go to file
Alex 610adcbefc Sources in responses
2023-06-11 22:56:34 +01:00
.github/workflows fix workflow: upgrade "build and push" action version to the latest 2023-05-16 08:02:13 +02:00
application Sources in responses 2023-06-11 22:56:34 +01:00
extensions Linting 2023-05-13 10:36:17 +02:00
frontend Sources in responses 2023-06-11 22:56:34 +01:00
scripts updating the bulk ingest file metadata to account for parsers that output lists 2023-05-19 10:29:18 -07:00
.env-template Update .env-template to OPENAI_API_KEY 2023-05-26 08:57:11 +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-dev.yaml Added dev docker compose file 2023-04-26 19:05:50 +01:00
docker-compose.yaml Merge branch 'main' into feature/streaming 2023-05-31 22:15:53 +01: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 Update README.md 2023-06-03 16:09:10 +01: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.

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!

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

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