124 lines
3.3 KiB
Markdown
124 lines
3.3 KiB
Markdown
# AI阅读心得助手 (AI Reading Reflection Assistant)
|
||
|
||
一个基于Electron和Vue开发的桌面应用程序，利用人工智能技术帮助用户快速生成高质量的读书心得和反思。
|
||
|
||
## 功能特色
|
||
|
||
- **AI驱动的读书心得生成**：基于用户输入的书籍信息，利用大语言模型自动生成深度读书心得
|
||
- **多职业视角**：根据用户的职业背景（学生、教师、职场人士、科研工作者等）定制化生成内容
|
||
- **智能摘要与关键词提取**：自动生成内容摘要和关键词，便于回顾和索引
|
||
- **任务管理**：支持批量处理多个读书反思任务
|
||
- **现代化UI界面**：使用Vue和Arco Design构建的精致极简主义界面
|
||
|
||
## 技术架构
|
||
|
||
- **主框架**：Electron + Vue 3
|
||
- **AI集成**：LangChain + LangGraph，支持结构化AI内容生成
|
||
- **数据库**：TypeORM + SQLite，本地数据存储
|
||
- **后端通信**：tRPC，类型安全的API调用
|
||
- **构建工具**：Vite + TypeScript
|
||
- **UI组件库**：Arco Design Vue
|
||
- **样式框架**：UnoCSS
|
||
|
||
## 核心功能模块
|
||
|
||
1. **AI服务模块**：集成大语言模型，实现读书心得的智能生成
|
||
2. **状态管理**：使用LangGraph管理AI生成流程的状态
|
||
3. **数据库管理**：使用TypeORM管理任务数据和用户配置
|
||
4. **任务管理器**：支持批量处理和任务状态追踪
|
||
5. **用户界面**：现代化Vue界面，支持任务创建、查看和管理
|
||
|
||
## 安装与运行
|
||
|
||
### 环境要求
|
||
|
||
- Node.js >= 18
|
||
- pnpm (推荐)
|
||
|
||
### 开发环境设置
|
||
|
||
1. 克隆项目：
|
||
```bash
|
||
git clone <your-repo-url>
|
||
cd read_book
|
||
```
|
||
|
||
2. 安装依赖：
|
||
```bash
|
||
pnpm install
|
||
```
|
||
|
||
3. 启动开发模式：
|
||
```bash
|
||
pnpm dev
|
||
```
|
||
|
||
### 构建与打包
|
||
|
||
1. 构建应用：
|
||
```bash
|
||
pnpm build
|
||
```
|
||
|
||
2. 打包为桌面应用：
|
||
```bash
|
||
# Windows
|
||
pnpm build:win
|
||
|
||
# macOS
|
||
pnpm build:mac
|
||
|
||
# Linux
|
||
pnpm build:linux
|
||
```
|
||
|
||
## AI工作流程
|
||
|
||
本应用使用LangGraph构建AI工作流程：
|
||
|
||
1. **内容生成节点**：根据书籍信息和用户职业背景生成读书心得正文
|
||
2. **摘要生成节点**：对生成的内容进行摘要和关键词提取
|
||
3. **结构化输出**：使用Zod模式确保输出格式的一致性
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
src/
|
||
├── main/ # Electron主进程
|
||
│ ├── db/ # 数据库配置
|
||
│ ├── manager/ # 任务管理器
|
||
│ └── services/ # 核心服务
|
||
│ └── ai/ # AI服务
|
||
├── renderer/ # Vue渲染进程
|
||
│ ├── components/ # UI组件
|
||
│ ├── pages/ # 页面组件
|
||
│ └── views/ # 视图组件
|
||
├── preload/ # 预加载脚本
|
||
├── rpc/ # tRPC配置
|
||
└── shared/ # 共享类型定义
|
||
```
|
||
|
||
## 配置
|
||
|
||
应用使用TypeScript进行类型安全的开发，并通过以下方式配置：
|
||
|
||
- **构建配置**：`electron.vite.config.ts`
|
||
- **样式配置**：`uno.config.ts`
|
||
- **TypeScript配置**：`tsconfig.json`
|
||
- **数据库配置**：`src/main/db/data-source.ts`
|
||
|
||
## 贡献
|
||
|
||
欢迎提交Issue和Pull Request来改进项目。
|
||
|
||
## 许可证
|
||
|
||
本项目采用 [在此添加您的许可证] 许可证。
|
||
|
||
## 致谢
|
||
|
||
- Electron - 跨平台桌面应用框架
|
||
- Vue.js - 前端框架
|
||
- LangChain & LangGraph - AI开发框架
|
||
- Arco Design - UI组件库
|