bookkeeping/README.md
yovinchen a2489c4987 docs: 更新README文档,突出项目功能亮点
- 新增"功能亮点"部分,重点展示已完成的核心功能
  - 智能数据分析:月度/年度报表、详细分析、多维度统计
  - 预算管理系统:多层级预算、实时监控、灵活配置
  - 数据安全保障:备份加密、离线优先、隐私保护
  - 现代化设计:Material 3、深色模式、响应式布局
- 更新主要特性,标注预算管理为"基本完成"
- 更新v1.5版本历史,记录崩溃修复和功能优化
- 优化文档结构,提升可读性和专业度

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-07-20 00:25:07 +08:00

249 lines
6.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 轻记账 (Lightweight Bookkeeping)
一个轻量级的个人记账应用,专注于隐私和离线使用。
## 📖 项目概述
本项目是一个使用 Kotlin 和 Jetpack Compose 开发的 Android 记账应用,采用 MVVM 架构,提供简洁直观的用户界面和丰富的记账功能。
## 🔥 功能亮点
### 📊 智能数据分析
- **月度/年度报表**:收支对比、储蓄率、日均消费等关键指标
- **详细分析报表**分类统计明细、TOP排行榜、可视化进度条
- **多维度统计**:支持按分类、成员、时间等多维度数据分析
### 💼 预算管理系统
- **多层级预算**:支持总预算、分类预算、成员预算
- **实时监控**:预算使用情况可视化,超支警告提醒
- **灵活配置**:可启用/禁用预算,自定义预警阈值
### 🔐 数据安全保障
- **备份加密**:使用 Android Keystore 加密导出文件
- **离线优先**:完全本地存储,无网络依赖
- **隐私保护**:极简权限,数据完全掌控
### 🎨 现代化设计
- **Material 3**:遵循最新设计规范
- **深色模式**:支持系统主题切换
- **响应式布局**:适配不同屏幕尺寸
## ⭐️ 主要特性
- 🔒 完全离线运行,无需网络连接
- 📱 极简权限要求,仅使用必要的系统权限
- 💰 支持收入和支出记录
- 👥 支持多人记账
- 📊 按日期和类别统计
- 🔐 备份文件加密保护
- 📅 自定义月度记账周期
- 💼 预算管理(基本完成)
- 📈 详细数据分析报表
## 🛠 技术栈
- 💻 开发语言Kotlin
- 🎨 UI 框架Jetpack Compose
- 🏗️ 架构模式MVVM
- 💾 数据存储Room Database
- 💉 依赖注入Hilt
- ⚡️ 异步处理Kotlin Coroutines
## 🗺 开发路线图
### 0. 基础记账 (已完成 ✨)
- [x] 收入/支出记录管理
- [x] 分类管理系统
- [x] 自定义日期选择器
- [x] Material 3 设计界面
- [x] 深色/浅色主题切换
- [x] 主题色自定义
- [x] 月度记账开始日期
### 1. 成员系统 (已完成 🎉)
- [x] 成员添加/编辑/删除
- [x] 记账时选择相关成员
- [x] 主页账单修改相关成员
- [x] 成员消费统计
### 2. 图表分析 (已完成 🎉)
- [x] 支出/收入趋势图表
- [x] 分类占比饼图
- [x] 月度/年度报表
- [x] 成员消费分析
- [x] 自定义统计周期
### 3 图标美化计划 (已完成 🎉)
- [x] 食品类图标 (餐饮、零食、饮料等)
- [x] 交通类图标 (公交、打车、加油等)
- [x] 购物类图标 (超市、数码、服装等)
- [x] 居住类图标 (房租、水电、物业等)
- [x] 医疗类图标 (药品、诊疗、保健等)
- [x] 娱乐类图标 (游戏、电影、旅游等)
- [x] 学习类图标 (书籍、课程、文具等)
- [x] 其他类图标 (礼物、捐赠、其他等)
- [x] 收入类图标 (工资、奖金、理财等)
- [x] 成员图标 (家人、朋友、同事等)
### 4. 数据管理 (已完成 🎉)
- [x] 导出 CSV/Excel 功能
- [x] 数据导入
- [x] 数据迁移工具
- [x] 定期自动备份
- [x] 备份加密功能
### 5. 预算管理 (基本完成 ✨)
- [x] 预算数据模型设计
- [x] 数据库架构实现
- [x] 预算管理界面
- [x] 月度预算设置
- [ ] 预算超支提醒
- [x] 分类预算管理
- [x] 成员预算管理
- [ ] 预算分析报告
### 6. 体验优化 (持续进行 🔄)
- [x] 深色模式支持
- [ ] 手势操作优化
- [ ] 多语言支持
- [ ] 自定义主题
### 7. 性能提升 (持续进行 ⚡️)
- [ ] 大数据量处理优化
- [ ] 启动速度优化
- [ ] 内存使用优化
- [ ] 缓存策略优化
- [ ] 数据库查询优化
## 🌲 分支管理
- `master`: 稳定主分支
- `develop`: 主开发分支
- `feature/*`: 功能开发分支
- `release/*`: 版本发布分支
- `hotfix/*`: 紧急修复分支
## 🔄 提交规范
提交信息应遵循以下格式:`<type>: <description>`
### 提交类型Type
- `feat`: 新功能feature
- `fix`: 修复bug
- `docs`: 文档更新documentation
- `style`: 代码格式(不影响代码运行的变动)
- `refactor`: 代码重构既不是新增功能也不是修复bug
- `perf`: 性能优化
- `test`: 测试相关
- `build`: 构建相关
- `ci`: 持续集成
- `chore`: 构建过程或辅助工具的变动
- `revert`: 回退提交
- `improvement`: 改进
## 📝 版本历史
### v1.5 (开发中)
- 预算管理功能
- 预算数据模型设计
- 支持总预算、分类预算、成员预算
- 数据库架构实现升级到版本6
- 预算管理界面设计
- 预算编辑对话框
- 预算状态可视化(进度条、超支提醒)
- 预算导航集成
- 数据分析优化
- 月度/年度报表组件
- 详细分析报表(分类统计明细)
- 收支对比、储蓄率、日均消费分析
- TOP分类排行榜金银铜奖牌设计
- 报表视图集成到分析页面
- 修复嵌套滚动组件崩溃问题
### v1.4
- 数据安全功能
- 备份文件加密使用Android Keystore
- 支持加密CSV/Excel导出
- 自动检测和解密加密备份
- 设置页面加密开关
- 月度记账优化
- 自定义月度开始日期1-28号
- 所有统计基于自定义周期
### v1.3
- 图标美化计划
- 增加图标美化
- 支持图标选择
### v1.2.0 - v1.2.4
- 分类数据可视化
- 支出/收入分类饼图展示
- 分类占比详细统计
- 分类数据交互和筛选
- 成员数据可视化
- 成员消费饼图展示
- 成员支出占比统计
- 成员数据交互和筛选
- 趋势分析
- 日收支趋势折线图
- 收入支出双线对比
- 支持深色/浅色主题
- 图表交互和缩放
- 数据筛选
- 支持按日期范围筛选
- 支持按收入/支出类型筛选
- 支持按成员/分类筛选
### v1.1.0
- 成员管理功能
- 成员添加/编辑/删除
- 记账时选择相关成员
- 成员消费统计
- UI/UX 优化
- 记录展示优化
- 月度统计界面
- 分组展示优化
- 数据管理
- 记录筛选增强
- 数据库性能优化
- 状态管理重构
### v1.0.0
- 基础记账功能
- 收入/支出记录
- 金额、日期、分类、备注管理
- Material 3 设计界面
- 深色/浅色主题切换
- 主题色自定义
- 分类管理
- 默认分类预设
- 自定义分类支持
- 分类编辑与删除
- 月度统计
- 月度收支总览
- 月份快速切换
- 自定义日期选择器
## 🤝 贡献指南
1. Fork 项目
2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'feat: Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request
## 📄 许可证
本项目采用 Apache License 2.0 许可证 - 查看 [LICENSE](LICENSE) 文件了解详细信息
## 📮 联系方式
- 作者YovinChen
- 邮箱gzh298255@gmail.com
- 博客:[blog.hhdxw.top](https://blog.hhdxw.top)
## 🙏 致谢
感谢所有为这个项目做出贡献的开发者!