53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# Echo
|
||
|
||
Echo 是一个本地优先的个人记账 App，当前重点是自动记账、储值账户语义、AI 分类与本地账本分析。
|
||
|
||
## 当前文档入口
|
||
|
||
- 主说明：[design/README.md](design/README.md)
|
||
- 项目现状与阶段规划：[design/echo-阶段总结与规划.md](design/echo-%E9%98%B6%E6%AE%B5%E6%80%BB%E7%BB%93%E4%B8%8E%E8%A7%84%E5%88%92.md)
|
||
- 设计/规划整理结论：[design/设计整理-2026-03-12.md](design/%E8%AE%BE%E8%AE%A1%E6%95%B4%E7%90%86-2026-03-12.md)
|
||
- 版本与协作约定：[design/版本与协作约定.md](design/%E7%89%88%E6%9C%AC%E4%B8%8E%E5%8D%8F%E4%BD%9C%E7%BA%A6%E5%AE%9A.md)
|
||
|
||
## 常用命令
|
||
|
||
```bash
|
||
npm run dev
|
||
npm run build
|
||
npm run rules:sync
|
||
npm run rule:smoke
|
||
npm run version:sync
|
||
npm run release:patch
|
||
npm run release:minor
|
||
npm run release:major
|
||
```
|
||
|
||
## 版本管理
|
||
|
||
当前版本管理机制保留这套：
|
||
- `package.json.version` 是单一版本源。
|
||
- `npm run version:sync` 会同步 Android `versionCode/versionName`。
|
||
- `npm run release:*` 负责 bump 版本、同步 Android、提交 release commit 并打 tag。
|
||
|
||
建议按下面的方式使用：
|
||
- 日常开发不要直接在 `main` 上堆改动，开 `feat/*` 或 `fix/*` 分支。
|
||
- `main` 只保留已验证、准备发版的内容。
|
||
- release 必须在干净工作区执行。
|
||
|
||
当前仓库已经加了两条保护：
|
||
- 只能在 `main` 分支执行 release。
|
||
- 工作区有未提交改动时禁止 release。
|
||
|
||
## 目录说明
|
||
|
||
- `src/`：前端页面、状态、服务、SQLite 与 AI/通知逻辑。
|
||
- `android/`：Capacitor Android 工程和通知监听原生实现。
|
||
- `scripts/`：规则同步、版本同步、发布脚本。
|
||
- `design/`：当前说明文档、历史设计稿和整理索引。
|
||
|
||
## 说明
|
||
|
||
- 通知规则单一来源：`src/config/notificationRules.js`
|
||
- 修改通知规则后，需要执行一次 `npm run rules:sync`
|
||
- 当前 AI 第一阶段使用本地 DeepSeek Key，正式发布前仍建议切到后端代理模式
|