bookkeeping/README.md

138 lines
3.1 KiB
Markdown
Raw Normal View History

# 轻记账 (Lightweight Bookkeeping)
一个轻量级的个人记账应用,专注于隐私和离线使用。
## 项目概述
本项目是一个使用 Kotlin 和 Jetpack Compose 开发的 Android 记账应用,采用 MVVM 架构,提供简洁直观的用户界面和丰富的记账功能。
## 主要特性
- 完全离线运行,无需网络连接
- 极简权限要求,仅使用必要的系统权限
- 支持收入和支出记录
- 支持多人记账
- 按日期和类别统计
## 技术栈
- 开发语言Kotlin
- UI 框架Jetpack Compose
- 架构模式MVVM
- 数据存储Room Database
- 依赖注入Hilt
- 异步处理Kotlin Coroutines
## 开发路线图
### 1. 基础记账 (已完成 )
- 收入/支出记录管理
- 分类管理系统
- 自定义日期选择器
- Material 3 设计界面
- 深色/浅色主题切换
- 主题色自定义
### 2. 成员系统 (已完成 )
- 成员添加/编辑/删除
- 记账时选择相关成员
- 成员消费统计
- 成员间账单分摊
### 3. 数据分析 (进行中 )
- 支出/收入趋势图表
- 分类占比饼图
- 月度/年度报表
- 成员消费分析
- 自定义统计周期
### 4. 数据管理 (计划中 )
- 导出 CSV/Excel 功能
- 云端备份支持
- 数据迁移工具
- 定期自动备份
- 备份加密功能
### 5. 预算管理 (计划中 )
- 月度预算设置
- 预算超支提醒
- 分类预算管理
- 成员预算管理
- 预算分析报告
### 6. 体验优化 (持续进行 )
- 深色模式支持
- 手势操作优化
- 快速记账小组件
- 多语言支持
- 自定义主题
### 7. 性能提升 (持续进行 )
- 大数据量处理优化
- 启动速度优化
- 内存使用优化
- 缓存策略优化
- 数据库查询优化
2024-11-27 13:09:28 +08:00
## 分支管理
- `master`: 稳定主分支
- `develop`: 主开发分支
- `feature/*`: 功能开发分支
- `release/*`: 版本发布分支
- `hotfix/*`: 紧急修复分支
## 版本历史
### v1.1.0 (2024-01-10)
- 成员管理功能
2024-11-27 13:09:28 +08:00
- 成员添加/编辑/删除
- 记账时选择相关成员
2024-11-27 13:09:28 +08:00
- 成员消费统计
- UI/UX 优化
2024-11-27 13:09:28 +08:00
- 记录展示优化
- 月度统计界面
- 分组展示优化
- 数据管理
2024-11-27 13:09:28 +08:00
- 记录筛选增强
- 数据库性能优化
- 状态管理重构
### v1.0.0 (2024-01-05)
- 基础记账功能
2024-11-27 13:09:28 +08:00
- 收入/支出记录
- 金额、日期、分类、备注管理
- Material 3 设计界面
2024-11-27 13:09:28 +08:00
- 深色/浅色主题切换
- 主题色自定义
- 分类管理
2024-11-27 13:09:28 +08:00
- 默认分类预设
- 自定义分类支持
- 分类编辑与删除
- 月度统计
2024-11-27 13:09:28 +08:00
- 月度收支总览
- 月份快速切换
- 自定义日期选择器
2024-11-27 13:09:28 +08:00
## 贡献指南
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
## 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详细信息
2024-11-27 13:09:28 +08:00
## 联系方式
- 作者YovinChen
- 邮箱gzh298255@gmail.com
2024-11-27 13:09:28 +08:00
- 博客:[blog.hhdxw.top](https://blog.hhdxw.top)
## 致谢
感谢所有为这个项目做出贡献的开发者!