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.
We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.
You can find our roadmap here. Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!
|Requirements (or similar)
If you don't have enough resources to run it, you can use bitsnbytes to quantize.
🔍🔥 Live preview
👩💻👨💻 Interested in contributing?
Application - Flask app (main application).
Extensions - Chrome extension.
Scripts - Script that creates similarity search index and stores for other libraries.
Frontend - Frontend uses Vite and React.
Note: Make sure you have Docker installed
On Mac OS or Linux, write:
It will install all the dependencies and allow you to download the local model or use OpenAI.
Otherwise, refer to this Guide:
Download and open this repository with
git clone https://github.com/arc53/DocsGPT.git
.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:
Navigate to http://localhost:5173/.
To stop, just run
Ctrl + C.
docker compose -f docker-compose-dev.yaml build
docker compose -f docker-compose-dev.yaml up -d
Make sure you have Python 3.10 or 3.11 installed.
.env file in the
.env with your OpenAI API token for the
application/core/settings.py if you want to see more config options.)
a) On Mac OS and Linux
python -m venv venv
b) On Windows
python -m venv venv
application/ subdir by the command
cd application/ and install dependencies for the backend:
pip install -r requirements.txt
flask run --host=0.0.0.0 --port=7091.
celery -A application.app.celery worker -l INFO.
Make sure you have Node version 16 or higher.
vite (ignore if installed).
npm install husky -g
npm install vite -g
npm install --include=dev.
npm run dev.
Please refer to the CONTRIBUTING.md file for information about how to get involved. We welcome issues, questions, and pull requests.
We as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. Please refer to the CODE_OF_CONDUCT.md file for more information about contributing.
Built with 🦜️🔗 LangChain