Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3Alan/DocsMind
🤖 DocsMind allows you to chat with your docs and summarize your docs, support pdf, md.
https://github.com/3Alan/DocsMind
chatgpt chatpaper chatpdf gpt langchain llama-index markdown pdf pdfgpt summarizer
Last synced: about 1 month ago
JSON representation
🤖 DocsMind allows you to chat with your docs and summarize your docs, support pdf, md.
- Host: GitHub
- URL: https://github.com/3Alan/DocsMind
- Owner: 3Alan
- License: agpl-3.0
- Created: 2023-03-22T16:00:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-05-14T16:41:52.000Z (over 1 year ago)
- Last Synced: 2024-07-27T20:46:11.374Z (about 1 month ago)
- Topics: chatgpt, chatpaper, chatpdf, gpt, langchain, llama-index, markdown, pdf, pdfgpt, summarizer
- Language: TypeScript
- Homepage: https://docs-mind.alanwang.site
- Size: 36.4 MB
- Stars: 172
- Watchers: 7
- Forks: 73
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - 3Alan/DocsMind - 🤖 DocsMind allows you to chat with your docs and summarize your docs, support pdf, md. (TypeScript)
README
# DocsMind
DocsMind is an open-source project that allows you to chat with your docs.
It is currently under development and there may be major changes at any time.
## 🎬 Demo
[Demo Site](https://docs-mind.alanwang.site/)
> **Warning**
>
> Due to the free plan of Railway only providing 500 hours per month, the Demo on the 21st day of each month will not be available. Please clone it locally for use at that time.
## 🌟 Features
- 🤖 Ask a question with your docs
- 📝 Summarize docs
- 🖍️ Highlight source
- 📤 Upload docs .pdf,.md(best support)
- 💾 Data saved locally
- 💰 Token usage tracker
- 🐳 Dockerize
## 🚀 Road Map
- [ ] Chat mode
- [ ] Dark mode
- [ ] / command (/fetch /summarize)
- [ ] Reduce the size of the server image.
- [ ] Support for more docs formats: txt...
- [ ] Download docs from the internet
- [ ] Markdown-formatted message
- [ ] i18n
- [ ] Desktop application
If you find this project helpful, please consider giving it a star 🌟
## 💻 Environment Variables
| Name | Description | Optional |
| -------------------- | -------------------------------------- | -------- |
| OPENAI_PROXY | will replace https://api.openai.com/v1 | ✅ |
| VITE_SERVICES_URL | backend url for frontend code | ✅ |
| VITE_DISABLED_UPLOAD | DISABLED_UPLOAD | ✅ |
## ❓ FAQ
This project includes both frontend (/client) and backend (/server) code. The frontend code is used to display the UI, while the backend code provides services to the UI.
### How to deploy?
[More details](https://github.com/3Alan/DocsMind/blob/main/Deployment.md)
### How to run?
> **Warning**
>
> Please check if you can access OpenAI in your region, you can refer to the [issue](https://github.com/3Alan/DocsMind/issues/3#issuecomment-1511470063) for more information.
1. Create .env
Create a `.env` file and copy the contents of `.env.example` to modify it.
2. Run App
```bash
docker-compose up -d
```
Please add `--build` to rebuild the image after each code update.
```bash
docker-compose up -d --build
```
now you can access the app at `http://localhost:8081`
All data will be saved in the `./data` directory.
### Local Development
Detail
#### Create .env
Create a `.env` file and copy the contents of `.env.example` to modify it.
#### Run Frontend UI
1. Install dependencies
```
yarn
```
2. Run app
```
yarn dev
```
#### Run Backend Services
you need a python environment
1. Create virtual environment
```
cd server
python -m venv .venv
```
2. Active virtual environment
windows
```
.venv\Scripts\activate
```
mac
```
. .venv/bin/activate
```
3. Install dependencies
```
pip install -r requirements.txt
```
4. Run Services
```
flask run --reload --port=8080
```
## 📝 License
[AGPL-3.0 License](https://github.com/3Alan/DocsMind/blob/main/LICENSE)
## ☕ Buy me a coffee
[](https://ko-fi.com/N4N1L5Y7V)
Alipay and Wechat
