DreamQuick 是一个本地优先的 Android 梦境记录应用,用于录音、转写、整理和回顾梦境内容。项目当前处于 MVP 阶段,重点覆盖录音入口、历史记录、详情编辑、回顾流程、用户词表和本地中文 ASR 降级链路。
- 用 Jetpack Compose 构建梦境记录、转写、编辑和回顾的最小可用体验。
- 使用 Room 保存梦境、转写文本、音频资产、AI 处理结果、处理任务和用户词表。
- 接入 Sherpa ONNX 本地中文 ASR,并保留可降级的转写与文本后处理架构。
- 保持模块边界清晰,便于后续接入更完整的 AI 总结、标签、检索和同步能力。
app/ Android application entry point, DI wiring, navigation
core/audio/ Recording, playback, ASR, punctuation and lexicon correction
core/common/ Shared result, error, time and text utilities
core/database/ Room database, DAO, entities, migrations and repositories
core/datastore/ User preference persistence
core/domain/ Domain interfaces and contracts
core/model/ Shared model types
core/ui/ Shared Compose UI primitives
feature/home/ Home screen and recent dream entry state
feature/record/ Recording flow
feature/history/ Dream history list and editing flow
feature/detail/ Detail page, transcript editing and audio actions
feature/review/ Review and resolved review screens
feature/settings/ Settings and user lexicon screens
工程prd/ Product requirements, architecture contracts and implementation notes
- 用户数据来自设备本地输入,包括录音、转写文本、标题、梦境条目、回顾状态和用户词表。
- 默认持久化层为本地 Room 数据库和 DataStore。
- 本地 ASR 使用
app/src/main/assets/sherpa-onnx/下的 Sherpa ONNX 中文模型资源。 - 项目不默认依赖云端数据源;后续如接入云端 AI 或同步服务,应在对应模块和文档中补充数据来源、权限和隐私说明。
Prerequisites:
- Android Studio 或可用的 Android SDK
- JDK 17
- Git LFS,用于拉取
.onnx模型文件
Clone and build:
git lfs install git clone https://github.com/multicosphy/Project-DreamQuick.git cd Project-DreamQuick .\gradlew :app:assembleDebug
Run focused checks:
.\gradlew :core:common:test :feature:home:testDebugUnitTest :feature:history:testDebugUnitTest
- 仓库按个人项目规则命名为
Project-DreamQuick。 README.md使用中文说明项目定位,仓库名使用英文以避免 URL、命令行和跨平台路径编码问题。local.properties、Gradle 构建产物、IDE 缓存和本地编辑器状态不会进入 Git。*.onnx通过 Git LFS 管理,避免把 100MB 以上的大模型文件写入普通 Git 对象。
No license has been declared yet.