本文介绍如何获取灵动课堂 Web 端 GitHub 源码并运行项目,快速启动并体验灵动课堂。
下图展示了启动灵动课堂的基本流程。
当你的 app 客户端请求加入灵动课堂时:
在你的设备上运行灵动课堂依赖于 Git(用于下载源码)、Node.js(用于构建运行项目)、Yarn(源码包管理工具)、Lerna(源码包管理工具)和 nvm(Node.js 版本管理命令行工具)。
你可参考以下步骤准备开发环境:
点击链接前往下载 Git。
点击链接前往下载 Node.js,建议 Node.js 14 或以上版本。
安装 Yarn:
如果你安装了 Node.js 16.10 及以上版本,可使用以下命令直接启用 Yarn(Windows 系统需要管理员身份运行 CMD 执行命令):
corepack enable
如果你安装了 Node.js 16.10 以下版本,需要使用以下命令先安装 Corepack,再启用 Yarn:
npm i -g corepack enable
安装 Lerna:
yarn add global lerna
(可选)安装 nvm:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
灵动课堂 Web 端的源码位于 GitHub CloudClass-Desktop 仓库,你可参考以下步骤获取源码:
运行以下命令克隆仓库到本地:
git clone https://github.com/AgoraIO-Community/CloudClass-Desktop.git
运行以下命令切换分支至指定版本,将 {VERSION} 替换为要切换的版本号:
git checkout release/{VERSION}
例如要切换到 2.6.0 版本分支,执行以下命令:
git checkout release/2.6.9
声网建议你切换到最新发版分支。参考下图在 GitHub 仓库中查看最新发版分支:
按照以下步骤启动灵动课堂:
运行以下命令安装项目依赖:
yarn
运行以下命令安装依赖包:
yarn bootstrap
将项目根目录下的 .env.example
文件移动至 packages/agora-classroom-sdk
并更名为 .env
:
mv .env.example packages/agora-classroom-sdk/.env
将你的 App ID 和 App Certificate 填写到 .env
文件中指定位置:
REACT_APP_AGORA_APP_ID={your appid}
REACT_APP_AGORA_APP_CERTIFICATE={your app certificate}
为方便你快速测试,CloudClass-Desktop 项目中已包含一个临时 RTM Token 生成器,会用你传入的 App ID 和 App 证书生成一个临时 RTM Token。但是在正式环境中,为确保安全,RTM Token 必须在服务端生成。
运行以下命令以开发模式启动灵动课堂 Web 端:
yarn dev
打开浏览器,输入地址 http://localhost:3000
,即可看到灵动课堂的登录页。输入房间名、用户名,选择一种班型,然后点击加入。
现在你已经初步体验了灵动课堂的功能,接下来可将灵动课堂集成到你自己的项目中。