Skip to content

SETUP.md

Latest commit

 

History

History
146 lines (109 loc) · 3.54 KB

SETUP.md

File metadata and controls

146 lines (109 loc) · 3.54 KB

ComposeCraft 项目设置指南

项目状态

✅ 项目代码已全部完成，包括：

  • 多模块架构设置
  • 核心模块（设计系统、公共工具、数据库）
  • 功能模块（笔记编辑、手绘画板）
  • 主应用模块和导航
  • 完整的 MVI 架构实现

在 Android Studio 中打开项目

方法 1: 直接打开（推荐）

  1. 打开 Android Studio
  2. 选择 File -> Open
  3. 选择项目根目录 untitled folder
  4. Android Studio 会自动识别这是一个 Gradle 项目
  5. 等待 Gradle 同步完成（首次同步会下载依赖，需要一些时间）

方法 2: 使用 Gradle Wrapper

如果 Android Studio 没有自动生成 Gradle Wrapper，可以手动生成：

# 进入项目目录
cd "untitled folder"

# 如果系统已安装 Gradle，运行
gradle wrapper

# 或者直接在 Android Studio 中：
# File -> Sync Project with Gradle Files

运行项目

1. 连接设备或启动模拟器

物理设备:

  • 在手机上启用开发者选项和 USB 调试
  • 用 USB 连接手机到电脑

Android 模拟器:

  • 在 Android Studio 中打开 AVD Manager
  • 创建或启动一个 API 26+ 的模拟器

2. 运行应用

  • 点击工具栏的绿色 Run 按钮 ▶️
  • 或使用快捷键 Shift + F10 (Windows/Linux) 或 Control + R (Mac)
  • 选择目标设备
  • 等待应用安装并启动

功能验证

应用启动后，你可以测试：

笔记功能

  1. 主页点击"笔记"进入
  2. 点击右下角 + 按钮新建笔记
  3. 输入标题和内容
  4. 点击右上角 ✓ 保存
  5. 返回列表查看笔记
  6. 点击笔记可以编辑
  7. 点击删除按钮删除笔记

画板功能

  1. 主页点击"画板"进入
  2. 在画板上自由绘制
  3. 选择不同颜色
  4. 调整笔刷大小
  5. 点击清空按钮清空画板

可能遇到的问题

1. Gradle 同步失败

解决方案:

  • 检查网络连接（需要下载依赖）
  • File -> Invalidate Caches / Restart
  • 确保使用 JDK 17

2. SDK 版本问题

解决方案:

  • 打开 SDK Manager
  • 安装 Android SDK 34
  • 安装 Build Tools 34.0.0

3. 依赖下载慢

解决方案:

  • 配置 Gradle 镜像（可选）
  • 在 gradle.properties 中添加：
systemProp.https.proxyHost=你的代理地址
systemProp.https.proxyPort=代理端口

项目架构说明

ComposeCraft/
├── app/                    # 主应用模块
│   ├── di/                # Hilt 依赖注入
│   ├── navigation/        # 导航配置
│   └── ui/                # 主页面
├── core/                  # 核心模块
│   ├── design-system/     # Material 3 主题和组件
│   ├── common/            # MVI 架构基类
│   └── database/          # Room 数据库
└── feature/               # 功能模块
    ├── editor/            # 笔记功能（完整 MVI）
    └── canvas/            # 画板功能（Canvas API）

技术栈

  • Kotlin 1.9.22
  • Jetpack Compose 2024.02.00
  • Hilt 2.50 (依赖注入)
  • Room 2.6.1 (数据库)
  • Navigation Compose 2.7.7
  • Coroutines & Flow (异步)
  • Material 3 (UI 设计)

下一步

项目已经可以运行，你可以：

  1. ✅ 在模拟器或真机上测试所有功能
  2. 📝 阅读代码了解 MVI 架构实现
  3. 🎨 自定义主题和颜色
  4. 🚀 添加更多功能
  5. 📱 发布到 Google Play

需要帮助？

如果遇到任何问题，可以：

  • 检查 Android Studio 的 Build 输出
  • 查看 Logcat 日志
  • 参考 README.md 了解更多信息

祝你使用愉快！🎉