Archives
/
DocsGPT
mirror of https://github.com/arc53/DocsGPT
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
435 Commits
16 Branches
10 Tags
66 MiB
Python 54.6%
TypeScript 38.3%
JavaScript 2.4%
CSS 1.9%
HTML 1.3%
Other 1.5%
 
 
 
 
 
 
main
dependabot/pip/application/transformers-4.38.0
dependabot/npm_and_yarn/extensions/react-widget/multi-4407677fd1
910-feature-better-error-handling-on-stream
feature/api-key-create
api-update
pr/892
fix/parsing-chunks-issue
feat/chunks
fix_model_selection_for_openai
feature/remote-loads
Fix-ingestion-grouping
feat/premaillm
feature/login-menu
fix_conversations_overflow
docs/sagemaker-guide
0.1.0
0.2.0
0.3.0
0.4.0
0.5.0
0.6.0
0.7.0
0.8.0
0.8.1
0.9.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ce6750be15'
${ noResults }
Go to file
Alex ce6750be15
Update README.md 		1 year ago
.github/workflows Update cife.yml 1 year ago
application Update .env_sample 1 year ago
extensions Botichello 1 year ago
frontend Update Navigation.tsx 1 year ago
scripts Merge pull request #168 from arc53/feature/backend-uploads 1 year ago
.gitignore feat(extension): migrate chrome extension v2 to v3 1 year ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 1 year ago
CONTRIBUTING.md Create CONTRIBUTING.md 1 year ago
LICENSE Initial commit 1 year ago
README.md Update README.md 1 year ago
Readme Logo.png Add files via upload 1 year ago
docker-compose.yaml cors + dependencies 1 year ago

README.md
Unescape Escape

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. Open docker-compose.yaml and replace <your_api_key> with your OpenAI's key (there are 4 places)
  3. Run docker-compose build && docker-compose up

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. Install dependencies pip install -r requirements.txt
  3. Prepare .env file Copy .env_sample and create .env with your openai api token
  4. Run the app python app.py
  5. Start worker with celery -A app.celery worker -l INFO

To start frontend

  1. Navigate to /frontend folder
  2. Install dependencies npm install
  3. In the file .env.development instead of VITE_API_HOST = https://docsapi.arc53.com use VITE_API_HOST=http://localhost:5001
  4. Run the app
  5. 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