docs: harness 工程文档

This commit is contained in:
AndyChen1024
2026-09-03 19:03:35 +08:00
parent 914daa19ac
commit 1b6f6d53ad
11 changed files with 388 additions and 0 deletions

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# 明缘进阶场 Android 客户端
「明缘进阶场」的 Android 客户端,与 `wechat-backend`(明缘进阶场 API)配套。采用 Kotlin + Jetpack Compose + Hilt + Retrofit + Room + DataStore + Navigation 的现代多模块架构,参考 Google Now in Android 官方示例。
## 项目状态
当前处于**基础建设阶段**:多模块骨架、约定插件、版本目录、验证脚本与 CI 均已就绪;各 feature 模块为空占位,尚未接入真实后端。详见 [docs/progress.md](docs/progress.md)。
## 快速开始
```bash
./gradlew :app:assembleDebug # 构建调试 APK
./gradlew test testDebugUnitTest # 运行单元测试
bash scripts/verify.sh # 完整验证
```
## 技术栈
- **UI**:Jetpack Compose + Material 3
- **架构**:多模块(app / core / feature)、MVVM、单向数据流(StateFlow)
- **依赖注入**:Hilt(KSP)
- **网络**:Retrofit + OkHttp + kotlinx-serialization
- **本地存储**:Room + DataStore
- **导航**:Navigation Compose
- **构建**:Gradle 约定插件(build-logic)+ 版本目录(version catalog)
- **质量**:Spotless/ktlint + Android Lint + 自定义架构检查
## 文档
架构、规范、测试、部署与决策记录见 [AGENTS.md](AGENTS.md) 的文档地图,或直接浏览 [docs/](docs/)。