diff --git a/README.md b/README.md index 3397e09..b57258f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Patbond Flutter -Patbond - -可运行在 Android、iOS、Web 和桌面平台。 +Patbond 客户端,可运行在 Android、iOS、Web 和桌面平台。 ## 功能 -- 社区动态搜索、点赞、收藏与评论 -- 模拟 AI 图片/视频创作和社区发布 -- 宠物资料、疫苗记录及健康档案管理 -- 医院、美容和个人服务搜索、筛选与模拟预约 -- 使用 `shared_preferences` 持久化宠物、疫苗和帖子数据 +- 注册登录、当前用户资料与头像、宠物头像 +- 宠物档案、体重与疫苗记录、健康档案与照护提醒 +- 社区:Feed 游标分页、帖子发布与详情、单层评论、点赞与收藏、关注 +- 中文本地化(`flutter_localizations`)与统一的日期录入 +- AI 创作(M4 进行中) -AI 创作、预约、账号和部分菜单目前仍为本地演示交互。 +**仍为本地演示交互的部分**:AI 创作页(M4 的替换目标)、预约、以及首页的天气/位置/圈子/促销卡四张卡片。后四项是**刻意保留的 demo 占位**并已在 ADR-022 登记去向,不是遗漏——天气与位置需接外部服务,圈子实为话题(ADR-018 剪出),促销卡属 M5 服务域。 + +数据以服务端为唯一事实来源,`shared_preferences` 只用于本地偏好与 anonymousId,不再持久化业务数据。 ## 运行 @@ -28,11 +28,49 @@ Web 调试: flutter run -d chrome ``` -## 验证 +后端地址通过 `--dart-define` 注入,默认指向本机各服务端口(auth 8081 / user 8082 / pet 8083 / community 8084 / creation 8085)。 + +## 本地门禁 + +与 CI 同一套命令(`.gitea/workflows/ci.yml`): ```bash dart format --output=none --set-exit-if-changed lib test flutter analyze flutter test -flutter build apk --debug ``` + +**每人每仓启用一次** pre-commit 凭证防泄漏钩子(ADR-021): + +```bash +git config core.hooksPath scripts/hooks +``` + +`scripts/check-secrets.sh` 是四仓同构副本,调整规则时四仓同步提交。 + +## 手工 E2E 脚本 + +仓库根目录下的 `test_e2e_*_manual.dart` 是按迭代累积的端到端烟囱脚本,需要一个在跑的后端,用 `dart run` 执行: + +```bash +dart run test_e2e_m3_manual.dart +``` + +两点须知: + +- 这些脚本**不被 `flutter test` 收集**,因此常规测试跑绿并不代表它们跑过;它们只在发布回归时手工执行。 +- 它们**被 `flutter analyze` 覆盖**,所以文件顶部需要 `// ignore_for_file: avoid_print`。 + +发布回归要求跑**全部**脚本,份数以 `patbond-doc` 的 `docs/development/releases.md` 为准。 + +## 真机验证 + +部分能力桌面端不可替代(移动端后台生命周期、`platform` 枚举不含 linux 故桌面埋点会被服务端拒收、选图与压缩无桌面实现),这些项目集中登记在 `patbond-doc` 的 `docs/development/device-verification.md`,含逐项步骤与通过标准。**模拟器是被接受的路径**,不必等真机。 + +## 相关仓库 + +| 仓库 | 内容 | +| --- | --- | +| `patbond-api` | Spring Boot 多模块后端 | +| `patbond-ai` | AI 生成服务(Python),只调服务商 API | +| `patbond-doc` | 契约(`docs/api/openapi.yaml`)、架构决策(`docs/architecture/decisions.md`)、迭代报告与发布记录 |