更新项目信息

wilinz · Jan 2, 2025 · 35d390c · 35d390c
1 parent 6c1fd6c
commit 35d390c
Show file tree

Hide file tree

Showing 34 changed files with 695 additions and 55 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -1,57 +1,238 @@
-# EazyWrite
+# 简单记账APP，一款功能强大UI漂亮的记账App
 
-## 下载地址：[https://github.com/wilinz/EazyWrite/actions](https://github.com/wilinz/EazyWrite/actions)
-找到最新的 Android Release ->  下载 Artifacts 下面编译好的 apk 文件
+## 概要
+### 下载地址：[https://disk.wilinz.com/share/0lchfzKx](https://disk.wilinz.com/share/0lchfzKx)
 
-## 手动合并Git:
+本项目已经完全开源，您使用本项目源代码需遵守开源协议。本项目使用 MPL 协议并附加以下条款：**不得将此项目及其衍生的项目的源代码和二进制产品用于一切任何商业和盈利用途，否则本人保留追究法律责任的权利**。使用者需确保在任何情况下都不会将本项目用于商业目的。如有疑问，请联系项目维护者以获取更多信息。
 
-```shell
-    # 拉取原仓库代码
-    git remote add upstream 要合并的仓库地址
-    git pull upstream
-    # 将原仓库代码合到自己仓库
-    git merge upstream/dev
-    # 推送到自己仓库
-    git push
-```
+### 许可证：MPL2.0
+基于 Mozilla Public License Version 2.0 并附加以下条款：
 
-## Github Action 云编译：
+* **非商业性使用** — 不得将此项目及其衍生的项目的源代码和二进制产品用于一切任何商业和盈利用途
 
-1. Fork 本仓库
-2. 在自己仓库的 Settings -> Secrets and variables -> Secrets -> Action 中添加 (New repository secret) 以下 Secrets
-   1. ANDROID_KEY_BASE64   # jks 证书文件的 base64 编码字符串
-   2. ANDROID_KS_PASS   # 证书密码
-   3. ANDROID_KEY_ALIAS  # 证书别名
-3. 添加完毕后，点击 Actions -> Android Release -> Run workflow 运行一次
-4. 等待编译完成后，点击 Actions -> Android Release ，下载 Artifacts 下面编译好的 apk 文件
-5. 解压下载的 *.apk.zip 文件, 安装运行
+### **开发配置**：查看 [README_DEV.md](README_DEV.md)
 
-## 文件转 base64
-### PowerShell:
-```shell
-# 将文件转换为base64编码并输出到控制台：
-[Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\path\to\file.txt"))
-```
-### Linux, MacOS:
-```shell
-# 将文件转换为base64编码并输出到控制台：
-base64 /path/to/file.txt
-```
-在上述命令中，你需要将 /path/to/file.txt 替换为实际的文件路径。
 
-## 创建 Android 签名证书教程
-1. 打开Android Studio，并进入你的项目。
 
-2. 选择菜单栏的Build，然后选择Generate Signed Bundle/APK。
+## 项目文档
 
-3. 在弹出的窗口中，选择您要打包的模块。如果您还没有配置签名证书，请单击Create New进行配置。
+### 作者：
+- [wilinz](https://github.com/wilinz)
+- [jixiuy](https://github.com/jixiuy)
+- [GuMu-Cat](https://github.com/GuMu-Cat)
+- [KWJYES](https://github.com/KWJYES)
 
-4. 在Key store path字段中，单击右侧的…并选择保存证书的位置。然后为证书指定一个名称。
+### UI设计：
+- [xiong0009](https://github.com/xiong0009)
 
-5. 在Key store password字段中输入密码，并确认。
+## 1 前言
 
-6. 输入Certificate信息，包括有效日期、姓名、单位、城市、州/省和国家/地区。
+现有的记账应用存在手工录入繁琐、功能不齐全、过度收集隐私、老年人使用记账应用的难度较大，所以需要更加智能化的解决方案。（详细市面其他应用分析和用户用研分析见详细方案文档）。我们团队利用合合信息提供的技术，结合自身知识储备，开发了一款简单记账APP。
 
-7. 输入Key信息，包括别名、密码、有效日期、姓名、单位、城市、州/省和国家/地区。
+## 2 创意描述
 
-8. 单击确认，稍等片刻，Android Studio就会生成一个签名证书。
+1. 通知栏快捷记账：不点击APP的情况下快速记录消费信息。
+
+2. 对话聊天机器人：能够和用户进行智能对话，提出意见。
+
+3. 微信支付宝导入功能：解析微信支付宝导出的账单文件得到账单信息并添加到App。
+
+4. 生成用户消费行为分析报告：通过用户的账单生成消费行为分析报告，让用户能够对自己的消费行为和兴趣爱好更加的了解，并且企业可以更好地了解顾客的需求和兴趣，进而对产品进行优化和改进。
+
+## 3 功能简介
+
+图3.1 功能分析图
+
+![功能分析](./assets/clip_image002.gif)
+
+### 3.1 基础功能
+
+1. 具备跨设备数据同步功能
+
+   (1) 登录登出修改密码功能  
+   图3.2 调整到登录界面
+
+   ![Stitch_20230413_084605](./assets/clip_image004.gif)
+
+   图3.3 登录、注册、修改密码功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_4.pngoutput_4](./assets/clip_image006.gif)
+
+2. 消费信息录入功能
+
+   图3.5 首页
+
+   ![Stitch_20230413_084739](./assets/clip_image010.gif)
+
+   (1) 手动录入
+
+   图3.6 手动录入功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_7.pngoutput_7](./assets/clip_image012.gif)
+
+   图3.7 手动录入功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_26.pngoutput_26](./assets/clip_image014.gif)
+
+   (2) 图片OCR全文识别录入
+
+   图3.8 拍照功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_8.pngoutput_8](./assets/clip_image016.gif)
+
+   图3.9 批量数据导入功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_9.pngoutput_9](./assets/clip_image018.gif)
+
+   (3) 图像增强处理
+
+   图3.10 图像增强功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_10.pngoutput_10](./assets/clip_image020.gif)
+
+3. 消费数据
+
+   (1) 展示
+
+   (2) 编辑
+
+   图3.11 数据修改和删除功能
+
+   ![Stitch_20230413_085128](./assets/clip_image022.gif)
+
+   (3) 通过时间段进行搜索过滤
+
+   图3.12 时间段过滤功能
+
+   ![Stitch_20230413_092531](./assets/clip_image024.gif)
+
+   (4) 通过消费类型进行搜索过滤
+
+   图3.13 消费类型过滤功能
+
+   ![Stitch_20230413_085739](./assets/clip_image026.gif)
+
+### 3.2 高级功能
+
+1. 自动判断消费类型
+
+   图3.14 图像增强功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_27.pngoutput_27](./assets/clip_image027.gif)
+
+2. 批量图像导入
+
+   图3.15 批量数据导入功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_14.pngoutput_14](./assets/clip_image028.gif)
+
+3. 多维度展示消费数据——折线图、饼状图
+
+   图3.16 多维度展示消费数据功能
+
+   ![Stitch_20230410_132218](./assets/clip_image030.gif)
+
+4. 支持多种消费凭据类别
+
+5. 大批量数据测试
+
+   图3.17 大批量数据测试功能
+
+   ![Stitch_20230413_094433](./assets/clip_image032.gif)
+
+   图3.18 存储的数据
+
+   ![B60D1DD43DB37915F707D6DC30B5F520](./assets/clip_image034.jpg)
+
+6. 个人健康管理功能（更多见创新功能）
+
+   图3.19 聊天小助手
+
+   ![Stitch_20230413_090610](./assets/clip_image036.gif)
+
+### 3.3 创新功能
+
+1. 拍照界面
+
+   图3.19 拍照功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_11.pngoutput_11](./assets/clip_image038.gif)
+
+2. 语音录入信息，通过语句生成账单
+
+   图3.20 语音录入功能
+
+   ![/private/var/folders/gf/vz_j65jx3xx79pmgh3b4v5t40000gn/T/com.kingsoft.wpsoffice.mac/picturecompress_20230410130030/output_17.pngoutput_17](./assets/clip_image040.gif)
+
+3. 微信支付宝导入账单
+
+   图3.21 微信支付宝账单导入功能
+
+   ![Stitch_20230412_085255](./assets/clip_image042.gif)
+
+4. 对话机器人，回答用户问题
+
+   图3.22 聊天小助手
+
+   ![Stitch_20230413_090807](./assets/clip_image044.gif)
+
+5. 桌面小组件快捷跳转，展示最近消费
+
+   图3.23 桌面小部件快捷记账功能
+
+   ![Stitch_20230410_162305](./assets/clip_image046.gif)
+
+6. 通知栏记账提醒和快捷记账
+
+   图3.24 通知栏快捷记账功能
+
+   ![Stitch_20230413_091103](./assets/clip_image048.gif)
+
+7. 用户反馈功能
+
+   图3.25 用户反馈功能
+
+   ![Stitch_20230413_091636](./assets/clip_image050.gif)
+
+8. 生成用户消费报告
+
+   图3.26 用户消费行为分析报告
+
+   ![IMG_20230413_173833](./assets/clip_image052.jpg)![C8486644C2360A2707FE335DDF76C153](./assets/clip_image054.jpg)![47C98FD06FC4B61A14087DE0BAC81A6C](./assets/clip_image056.jpg)
+
+9. 深色模式
+
+   图3.27 深色模式界面
+
+   ![Stitch_20230413_174724](./assets/clip_image058.gif)
+
+## 4 特色综述
+
+1. 采用合合信息提供的OCR全文识别和图像增强接口，自动识别和录入消费信息，提高用户体验。
+
+2. 适配深色模式：减少周围环境的干扰，从而提高文字、图片等内容的可读性。
+
+3. 桌面小组件：快捷查看消费信息与跳转记账。
+
+4. 语音录入：语音录入功能，让一段语音就能生成一张账单。
+
+5. 用户反馈：帮助管理员了解应用程序的优缺点，优化应用程序的功能和性能。
+
+## 5 开发工具和技术
+
+我们的产品是一款基于安卓平台的应用程序，采用了先进的开发技术。我们使用Android
+Studio作为开发平台，采用Kotlin语言和Java语言进行开发，并且采用MVVM框架来实现应用程序的UI（视图）与状态和行为（模型和视图模型）之间的分离，以提高代码的可读性和可维护性。我们还利用Retrofit进行网络请求，并使用Room数据库进行本地数据存储，以方便地进行数据的读取和存储。为了提高构建速度，我们使用了Material3组件和Compose声明式编程，从而使应用程序更加美观。我们还采用Github作为代码托管平台进行协同开发，并利用Figma进行界面UI的构建，以提高开发和设计效率。
+
+## 6 应用对象
+
+软件适用于所有需要管理自己财务状况的人群，包括学生、上班族、自由职业者等等。无论收入和支出情况如何，软件都可以帮助用户更好地掌握自己的财务状况。
+
+## 7 应用环境
+
+Android 手机
+
+## 8 结语
+
+我们在完成基础功能和高级功能的基础上，进行了多项创新，方便用户高效，快捷记账。软件采用了如MVVM、Compose等先进的技术，具有多项强大的功能，可以有效地帮助用户管理个人财务，让用户更好地了解自己的消费情况，合理规划财务，是一款实用性和便捷性都非常高的AI记账软件。
+
+
diff --git a/README_DEV.md b/README_DEV.md
@@ -0,0 +1,80 @@
+# EazyWrite
+
+## 配置本项目
+修改此文件
+```shell
+app/src/main/java/com/eazywrite/app/data/network/Network.kt
+```
+```kotlin
+object Network {
+
+    private const val baseUrl = "https://easywrite.wilinz.com/"
+    //    private const val baseUrl = "http://192.168.1.5:10010/"
+
+    //    val openaiUrl = "${baseUrl}openai/v1/"
+
+    // see https://www.ohmygpt.com/
+    private const val openaiUrl = "https://c-z0-api-01.hash070.com"
+
+    // see https://www.ohmygpt.com/
+    private val openaiKey = Base64.decode("api key base64").toString(Charsets.UTF_8) // TODO
+
+    private const val textinAppId = ""
+
+    private const val textinSecretCode = ""
+
+   //...
+}
+```
+## 手动合并Git:
+
+```shell
+    # 拉取原仓库代码
+    git remote add upstream 要合并的仓库地址
+    git pull upstream
+    # 将原仓库代码合到自己仓库
+    git merge upstream/dev
+    # 推送到自己仓库
+    git push
+```
+
+## Github Action 云编译：
+
+1. Fork 本仓库
+2. 在自己仓库的 Settings -> Secrets and variables -> Secrets -> Action 中添加 (New repository secret) 以下 Secrets
+   1. ANDROID_KEY_BASE64   # jks 证书文件的 base64 编码字符串
+   2. ANDROID_KS_PASS   # 证书密码
+   3. ANDROID_KEY_ALIAS  # 证书别名
+3. 添加完毕后，点击 Actions -> Android Release -> Run workflow 运行一次
+4. 等待编译完成后，点击 Actions -> Android Release ，下载 Artifacts 下面编译好的 apk 文件
+5. 解压下载的 *.apk.zip 文件, 安装运行
+
+## 文件转 base64
+### PowerShell:
+```shell
+# 将文件转换为base64编码并输出到控制台：
+[Convert]::ToBase64String([IO.File]::ReadAllBytes("C:\path\to\file.txt"))
+```
+### Linux, MacOS:
+```shell
+# 将文件转换为base64编码并输出到控制台：
+base64 /path/to/file.txt
+```
+在上述命令中，你需要将 /path/to/file.txt 替换为实际的文件路径。
+
+## 创建 Android 签名证书教程
+1. 打开Android Studio，并进入你的项目。
+
+2. 选择菜单栏的Build，然后选择Generate Signed Bundle/APK。
+
+3. 在弹出的窗口中，选择您要打包的模块。如果您还没有配置签名证书，请单击Create New进行配置。
+
+4. 在Key store path字段中，单击右侧的…并选择保存证书的位置。然后为证书指定一个名称。
+
+5. 在Key store password字段中输入密码，并确认。
+
+6. 输入Certificate信息，包括有效日期、姓名、单位、城市、州/省和国家/地区。
+
+7. 输入Key信息，包括别名、密码、有效日期、姓名、单位、城市、州/省和国家/地区。
+
+8. 单击确认，稍等片刻，Android Studio就会生成一个签名证书。