DocsMind

DocsMind 项目介绍

DocsMind 是一个开源项目，旨在帮助用户与文档进行互动。它允许用户通过对话的方式与文档进行交流，从而提高阅读和处理文档的效率。

项目概述

DocsMind 正在开发中，目前可能随时会有重大变化。用户可以通过上传不同格式的文档，如 .pdf 和 .md，与文档进行交互。用户可以在本地保存数据，并跟踪令牌使用情况。此外，该项目也支持 Docker 部署。

主要功能

• 🤖 与文档进行问答：用户可以提出与文档内容相关的问题。
• 📝 文档总结：帮助用户快速得到文档的概要信息。
• 🖍️ 重点标注：在文档中高亮显示关键部分。
• 📤 上传文档：支持 .pdf 和 .md 格式。
• 💾 本地保存数据：数据可以安全地存储在本地。
• 💰 令牌使用跟踪：用户可以跟踪 API 调用的令牌使用情况。
• 🐳 Docker 支持：可以利用 Docker 容器进行部署。

项目规划

DocsMind 有一个详细的发展计划，未来将实现以下功能：

• 增加聊天模式和夜间模式支持。
• 支持更多格式的文档，如 txt 格式。
• 可以从互联网下载文档。
• 支持 Markdown 格式的消息。
• 添加多语言支持（i18n）。
• 开发桌面应用程序版本。

环境变量

项目中使用了一些环境变量，帮助配置和运行应用程序：

• OPENAI_PROXY: 用于替换 OpenAI API 地址。
• VITE_SERVICES_URL: 前端与后端通信的基础 URL。
• VITE_DISABLED_UPLOAD: 管理文件上传功能。

常见问题解答

项目包含前端和后端代码，前端用于显示用户界面，而后端提供其服务支持。

如何部署？

用户可以通过 Docker 进行快速部署，确保在部署前能访问 OpenAI 的服务。

如何运行？

1. 创建 .env 文件，并根据 .env.example 进行修改。
2. 运行应用程序：

   docker-compose up -d
   

在代码更新后，可以使用以下命令重新构建镜像并运行：

docker-compose up -d --build

应用程序将会在 http://localhost:8081 上可访问，所有数据将保存至 ./data 目录。

本地开发

对于开发者，DocsMind 提供了详细的本地开发步骤：

1. 创建并配置 .env 文件。
2. 安装前端依赖：

   yarn
   

3. 启动前端应用：

   yarn dev
   

4. 设置后端 Python 环境，激活虚拟环境，安装依赖，并运行服务：

在 Windows 上：

.venv\Scripts\activate

在 Mac 上：

. .venv/bin/activate

运行后端服务：

flask run --reload --port=8080

许可证

DocsMind 使用 AGPL-3.0 许可证，所有代码均可在 GitHub 上查看。

支持项目

如果您觉得这个项目有帮助，可以通过各种方式支持它的发展。