docs: 更新README文档以详细描述系统功能模块

- 详细列出所有核心功能模块及其子功能
- 添加数据模型表格说明
- 补充异步任务相关信息
- 保持技术栈部分不变
This commit is contained in:
2026-01-25 20:51:11 +08:00
parent ab24c120e1
commit 73ebd804b8

111
README.md
View File

@@ -4,13 +4,110 @@
## 功能特性 ## 功能特性
- 阅读记录管理(支持添加阅读笔记) ### 核心功能模块
- 感悟记录管理
- 家庭事项管理(支持自定义事项类型) #### 1. 阅读记录管理
- 今日计划管理 - 支持添加、编辑、删除阅读记录
- 报告生成 - 阅读类型分类管理(如:书籍、文章、论文等)
- 邮件发送 - 记录阅读标题、来源、进度
- 后台管理界面(访问路径:/houtai - 支持添加阅读笔记
- 支持文件上传(阅读相关资料)
- 支持查看昨日和今日的阅读记录
#### 2. 感悟记录管理
- 支持添加、编辑、删除感悟记录
- 支持选择发言人(家庭成员)
- 感悟内容记录
- 支持文件上传(感悟相关资料)
- 支持查看昨日和今日的感悟记录
#### 3. 汇总记录管理
- 支持添加、编辑、删除汇总记录
- 汇总分类管理(如:新闻、知识、生活等)
- 支持选择发言人和来源
- 汇总内容记录
- 支持文件上传
#### 4. 家庭事项管理
- 支持添加、编辑、删除家庭事项
- 自定义事项类型
- 设置优先级(高、中、低)
- 设置状态(待处理、已完成等)
- 设置截止日期
- 支持按优先级和截止日期排序
#### 5. 今日计划管理
- 支持添加、编辑、删除今日计划
- 设置计划类型
- 设置优先级
- 设置状态(待处理、已完成)
- 支持状态快速切换
- 支持选择发言人
- 按优先级排序显示
#### 6. 报告生成与查看
- 自动生成每日家庭日报
- 报告内容包括:
- 昨日阅读记录汇总
- 昨日感悟记录汇总
- 昨日汇总记录
- 今日计划列表
- 家庭事项统计
- 支持查看历史报告
- 支持选择不同日期查看报告
#### 7. PDF报告生成
- 使用WeasyPrint生成PDF格式报告
- 支持报告预览HTML格式与PDF样式一致
- 支持下载PDF文件
- PDF文件自动保存到服务器
- 支持查看历史PDF文件列表
#### 8. 邮件发送功能
- 支持SMTP邮件发送
- 邮件包含PDF报告附件
- 支持定时发送通过Celery Beat
- 支持手动发送
- 可配置发送时间
- 支持多个收件人
#### 9. 系统配置
- SMTP服务器配置
- 发送时间设置
- 发件人邮箱配置
- 收件人邮箱配置
- 通过Web界面进行配置
#### 10. 后台管理界面
- 完整的Django Admin后台
- 访问路径:/houtai
- 管理所有数据模型
- 管理用户和权限
### 数据模型
| 模型 | 说明 | 主要字段 |
|-----|------|---------|
| ReadingType | 阅读记录类型 | name |
| FamilyTaskType | 家庭事项类型 | name |
| Priority | 优先级 | name |
| Status | 状态 | name |
| PlanType | 今日计划类型 | name |
| FamilyMember | 家庭成员 | name |
| ReadingRecord | 阅读记录 | date, type, title, source, progress, note, file |
| InsightRecord | 感悟记录 | date, content, speaker, file |
| Summary | 汇总记录 | date, category, speaker, content, source, file |
| FamilyTask | 家庭事项 | type, content, priority, status, deadline |
| TodayPlan | 今日计划 | date, content, speaker, priority, type, status |
| SystemConfig | 系统配置 | smtp_server, send_time, recipient_email等 |
### 异步任务
系统使用Celery处理异步任务
- `generate_daily_pdf_report`每日PDF报告生成
- `send_daily_report`:每日邮件发送
- 依赖Redis作为消息代理
- 支持定时任务调度
## 技术栈 ## 技术栈