• Get API key
• Install nodejs
• cp .env.example .env
• Install client dependencies
• cd client
• yarn install
• Install server dependencies
• from the root folder. cd server
• python3 -m venv env
• pip3 install -r requirements.txt

• Use vscode launch.json task to start the flask app server.
• cd client
• yarn dev

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

• 🤖 Ask a question with your docs
• 📝 Summarize docs
• 🖍️ Highlight source
• 📤 Upload docs .pdf,.md(best support)
• 💾 Data saved locally
• 💰 Token usage tracker
• 🐳 Dockerize

• 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 🌟

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.

More details

Warning

Please check if you can access OpenAI in your region, you can refer to the issue for more information.

1. Create .env

Create a .env file and copy the contents of .env.example to modify it.

2. Run App

docker-compose up -d

Please add --build to rebuild the image after each code update.

docker-compose up -d --build

now you can access the app at http://localhost:8081

All data will be saved in the ./data directory.

yarn

yarn dev

cd server
python -m venv .venv

.venv\Scripts\activate

. .venv/bin/activate

pip install -r requirements.txt

flask run --reload --port=8080

AGPL-3.0 License

Alipay and Wechat