# 跑通 UIKit 开源方案示例项目 (/zh-CN/solutions/online-ktv/auikaraoke/get-started/kit-demo/android)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
声网在 GitHub 上提供一个开源的 [AUIKaraoke 示例项目](https://github.com/AgoraIO-Community/AUIKitKaraoke/tree/main)。本文介绍如何快速跑通该示例项目,体验在线 K 歌场景。
## 前提条件 [#前提条件]
- [Git](https://git-scm.com/downloads)
- Android API Level 24 及以上
- Android Studio 3.5 及以上
- Android 设备,版本 Android 7.0 及以上
- [Java Development Kit](https://www.oracle.com/java/technologies/javase-downloads.html) 17 及以上
:::info[信息]
- 声网推荐使用真机运行项目。部分模拟机可能存在功能缺失或者性能问题。
- 本示例项目使用的 Java Development Kit 版本为 17,Gradle 版本为 7.2。如果你编译失败,请修改编译使用的 Java Development Kit 或 Gradle 版本。
:::
## 操作步骤 [#操作步骤]
### 获取示例项目 [#获取示例项目]
运行以下命令克隆仓库到本地:
```shell
git clone git@github.com:AgoraIO-Community/AUIKaraoke.git
```
### 配置示例项目 [#配置示例项目]
参考[开通 UIKit 开源方案相关服务](/zh-CN/solutions/online-ktv/auikaraoke/build/setup-and-access/enable-service)获取你的声网项目的 App ID、证书,以及环信项目的 APPKEY、Client ID 以及 Client Secret,参考[部署后端服务](/zh-CN/solutions/online-ktv/auikaraoke/build/manage-karaoke/run-github-project-backend)获取你的项目的后端服务的 Host URL,然后将上述信息填入项目的 `local.properties` 文件。
:::info[信息]
你也可以使用声网提供的测试域名 [https://service.shengwang.cn/uikit-v2](https://service.shengwang.cn/uikit-v2) 来快速体验,但请勿用于正式生产环境中。
:::
```properties
SERVER_HOST=<=你的后端服务域名=>
AGORA_APP_ID=<=你的声网 AppID=>
AGORA_APP_CERT=<=你的声网 App 证书=>
IM_APP_KEY=<=你的环信 APPKEY=>
IM_CLIENT_ID=<=你的环信 Client ID=>
IM_CLIENT_SECRET=<=你的环信 Client Secret=>
```
### 编译并运行示例项目 [#编译并运行示例项目]
1. 开启 Android 设备的开发者选项,打开 USB 调试,通过 USB 连接线将 Android 设备接入电脑,并在 Android 设备选项中勾选你的 Android 设备。
2. 在 Android Studio 中,点击 **Sync Project with Gradle Files** 按钮,以让项目与 Gradle 文件同步。
3. 待同步成功后,点击 开始编译。
4. 编译成功后,你的 Android 设备上会出现 **AUIKaraoke** App。
5. 打开 App,点击**创建房间**即可开始体验在线 K 歌。