Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-17 21:26:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
d3fab69155
DocsGPT/README.md
Alex b9efb98280
Update README.md
2023-04-04 14:12:35 +01:00

3.5 KiB
Raw Blame History

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