DocsGPT/README.md

72 lines
2.8 KiB
Markdown
Raw Normal View History

2023-02-05 19:52:42 +00:00
<h1 align="center">
DocsGPT 🦖
</h1>
2023-02-05 19:07:42 +00:00
<p align="center">
2023-02-05 20:31:27 +00:00
<strong>Open-Source Documentation Assistant</strong>
2023-02-05 19:07:42 +00:00
</p>
2023-02-05 19:09:02 +00:00
<p align="left">
2023-02-05 20:31:27 +00:00
<strong>DocsGPT</strong> is a cutting-edge open-source solution that streamlines the process of finding information in project documentation. With its integration of the powerful <strong>GPT</strong> models, developers can easily ask questions about a project and receive accurate answers.
2023-02-05 19:09:02 +00:00
2023-02-05 19:10:39 +00:00
Say goodbye to time-consuming manual searches, and let <strong>DocsGPT</strong> 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.
2023-02-05 19:09:02 +00:00
</p>
2023-02-05 19:07:42 +00:00
2023-02-05 20:24:06 +00:00
<div align="center">
2023-02-21 16:59:36 +00:00
2023-02-06 12:54:00 +00:00
<a href="https://discord.gg/n5BX8dh8rU">![example1](https://img.shields.io/github/stars/arc53/docsgpt?style=social)</a>
<a href="https://discord.gg/n5BX8dh8rU">![example2](https://img.shields.io/github/forks/arc53/docsgpt?style=social)</a>
<a href="https://discord.gg/n5BX8dh8rU">![example3](https://img.shields.io/github/license/arc53/docsgpt)</a>
<a href="https://discord.gg/n5BX8dh8rU">![example3](https://img.shields.io/discord/1070046503302877216)</a>
2023-02-21 16:59:36 +00:00
2023-02-05 20:24:06 +00:00
</div>
2023-02-05 19:27:48 +00:00
2023-02-21 18:20:47 +00:00
![Group 9](https://user-images.githubusercontent.com/17906039/220427472-2644cff4-7666-46a5-819f-fc4a521f63c7.png)
2023-02-21 16:23:14 +00:00
2023-02-05 20:46:33 +00:00
## Roadmap
2023-02-06 21:50:37 +00:00
You can find our [Roadmap](https://github.com/orgs/arc53/projects/2) here, please don't hesitate contributing or creating issues, it helps us make DocsGPT better!
2023-02-05 20:46:33 +00:00
2023-02-10 18:14:58 +00:00
## Preview
![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demo.gif)
2023-02-03 21:48:28 +00:00
2023-02-07 00:05:45 +00:00
## [Live preview](https://docsgpt.arc53.com/)
2023-02-03 21:52:46 +00:00
2023-02-06 13:10:17 +00:00
## [Join Our Discord](https://discord.gg/n5BX8dh8rU)
2023-02-03 21:48:28 +00:00
2023-02-03 12:07:33 +00:00
## Project structure
2023-02-09 08:21:05 +00:00
- Application - flask app (main application)
2023-02-03 14:49:28 +00:00
2023-02-09 08:21:05 +00:00
- Extensions - chrome extension
2023-02-03 14:49:28 +00:00
2023-02-09 08:21:05 +00:00
- Scripts - script that creates similarity search index and store for other libraries.
2023-02-03 12:07:33 +00:00
2023-02-03 14:52:22 +00:00
## QuickStart
Please note: current vector database uses pandas Python documentation, thus responses will be related to it, if you want to use other docs please follow a guide below
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`
2023-02-05 11:37:21 +00:00
2023-02-07 16:41:17 +00:00
[How to install the Chrome extension](https://github.com/arc53/docsgpt/wiki#launch-chrome-extension)
2023-02-05 11:37:21 +00:00
2023-02-03 12:07:33 +00:00
2023-02-03 14:49:02 +00:00
## [Guides](https://github.com/arc53/docsgpt/wiki)
2023-02-03 12:07:33 +00:00
2023-02-14 14:56:25 +00:00
## [Interested in contributing?](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
2023-02-03 12:07:33 +00:00
2023-02-03 14:49:02 +00:00
## [How to use any other documentation](https://github.com/arc53/docsgpt/wiki/How-to-train-on-other-documentation)
2023-02-15 18:42:56 +00:00
## [How to host it locally (so all data will stay on-premises)](https://github.com/arc53/DocsGPT/wiki/How-to-use-different-LLM's#hosting-everything-locally)
2023-02-03 14:49:02 +00:00
Built with [🦜️🔗 LangChain](https://github.com/hwchase17/langchain)
2023-02-03 21:50:52 +00:00