快速开始
介绍
本节帮助你尽快把 HCompass 跑起来,并了解如何创建和使用功能包。
一、环境准备
- DevEco Studio:已安装并可正常创建/运行 HarmonyOS 项目(推荐最新稳定版)
- Git:用于克隆仓库和拉取更新
TIP
如果环境尚未准备好,请先阅读 环境要求。
二、获取代码
bash
git clone https://github.com/codelably/HCompass.git
cd HCompass三、打开并运行
- 使用 DevEco Studio 打开项目根目录
- 等待依赖同步完成
- 运行
entry模块进入应用
四、项目结构
HCompass/
├── entry/ # 应用入口
├── core/ # 框架核心层
│ ├── base/ # 基础父类
│ ├── common/ # 通用模型
│ ├── components/ # 通用组件
│ ├── database/ # 本地数据库
│ ├── designsystem/ # 设计系统
│ ├── di/ # 依赖注入
│ ├── ibestui/ # IBest UI 组件库
│ ├── layoutstate/ # 布局状态
│ ├── module/ # 模块管理
│ ├── navigation/ # 导航系统
│ ├── network/ # 网络请求
│ └── util/ # 工具类
├── shared/ # 共享契约层
│ ├── contracts/ # 契约定义
│ ├── state/ # 共享状态
│ └── types/ # 类型定义
├── packages/ # 业务功能包层
│ ├── auth/ # 认证功能包
│ ├── demo/ # 示例功能包
│ ├── main/ # 主页功能包
│ └── user/ # 用户功能包
└── docs/ # 文档五、从示例开始
查看示例功能包
packages/demo 提供了完整的功能包示例,包括:
- 页面创建
- 状态管理
- 网络请求
- 数据库操作
- 导航跳转
创建新功能包
- 在
packages/目录下创建新的功能包目录 - 参考
demo功能包的结构创建文件 - 在 Shared 层定义契约(如需对外提供服务)
- 在功能包内实现业务逻辑
- 通过 DI 注入分享给其他模块
详细步骤请参考 创建功能包。
六、构建应用
bash
# 构建 HAP 包
hvigorw assembleHap -p product=default