Skip to content

编译Classroom SDK

Jump to bottom
Qianze Zhang edited this page Feb 21, 2021 · 7 revisions

我是否真的需要自己编译Classroom SDK?

  • 我们已经在https://www.npmjs.com/package/agora-classroom-sdk[npm]上发布了完整的Classroom SDK，该版本会不断迭代改良，并逐步开放订制能力，如果有目前SDK无法实现的功能，可以和我们的技术支持联系了解后续的版本规划，通过Classroom SDK集成可以在今后可以通过简单的升级获取更丰富的功能与更良好的体验，我们建议使用原版Classroom SDK集成

  • 如果你确认当前版本与未来版本规划无法满足你的要求，我们的Classroom SDK是完全开源的，你可以自行开发调试后编译Classroom SDK，自行修改编译可能会影响课堂体验，在将来升级SDK时也需要重新做相关的适配

编译Classroom SDK

准备工作

  • 请确保你已经完成灵动课堂项目指南中的[前提条件](https://docs.agora.io/cn/agora-class/agora_class_prep?platform=Web)。

  • 重命名 .env.example 为 .env，并配置以下参数： 

    # CONFIGS PROVIDED BY YOU
REACT_APP_AGORA_APP_ID=<YOUR APPID>
REACT_APP_NETLESS_APP_ID=<YOUR NETLESS APPID>

  • 中国区客户推荐使用以下方式安装 npm 依赖包和 electron & node-sass 加速 > 我们建议使用 npm 而非 yarn 或 cnpm 

    # 仅适用于中国区客户
# macOS
export ELECTRON_MIRROR="https://npm.taobao.org/mirrors/electron/"
export ELECTRON_CUSTOM_DIR="7.1.14"
export SASS_BINARY_SITE="https://npm.taobao.org/mirrors/node-sass/"
export ELECTRON_BUILDER_BINARIES_MIRROR="https://npm.taobao.org/mirrors/electron-builder-binaries/"

# Windows
set ELECTRON_MIRROR=https://npm.taobao.org/mirrors/electron/
set ELECTRON_CUSTOM_DIR=7.1.14
set ELECTRON_BUILDER_BINARIES_MIRROR=https://npm.taobao.org/mirrors/electron-builder-binaries/
set SASS_BINARY_SITE=https://npm.taobao.org/mirrors/node-sass/

npm install --registry=https://registry.npm.taobao.org

  • 安装 Node.js LTS

运行和发布 Web demo

  1. 安装 npm 

    npm install

  2. 本地运行 Web demo 

    npm run dev

  3. 生成Classroom SDK 

    npm run pack:npm

成功运行结束后会生成一个 dist 目录，里面包含一个edu_sdk.bundle.js文件即为Classroom SDK

Clone this wiki locally