快速跑通示例项目

前提条件

• Agora RTM Web SDK 支持的浏览器 (Chrome 49+, Firefox 52+, Safari 9+, Internet Explorer 11+)。
• 有效的 Agora 开发者账号。
• 如果你的网络环境部署了防火墙，请根据应用企业防火墙限制打开相关端口。
• npm

操作步骤

1. 创建 Agora 项目

按照以下步骤，在控制台创建一个 Agora 项目。

1. 登录 Agora 控制台，点击左侧导航栏 项目管理按钮进入项目管理页面。

2. 在项目管理页面，点击创建按钮。

   

3. 在弹出的对话框内输入项目名称，选择鉴权机制为 APP ID + Token。

4. 点击提交，新建的项目就会显示在项目管理页中。

2. 获取 App ID 和 App 证书

获取 App ID

Agora 会给每个项目自动分配一个 App ID 作为项目唯一标识。

在 Agora 控制台的项目管理页面，找到你的项目，点击 App ID 右侧的眼睛图标就可以直接复制项目的 App ID。

获取 App 证书

点击编辑进入编辑项目页面，你可以点击眼睛图标查看并复制 App 证书。

3. 生成 Token

为提高项目的安全性，Agora 使用 Token（动态密钥）对即将加入 RTM 系统的用户进行鉴权。

为了方便测试，Agora 提供生成临时 RTM Token 的功能，具体步骤如下：

1. 访问 https://webdemo.agora.io/token-builder/ 。
2. 填入 App ID，App 证书和用于登录 RTM 系统的用户 ID。
   你需要自行设置用户 ID，支持的字符集为：

   • 26 个小写英文字母 a-z
   • 26 个大写英文字母 A-Z
   • 10 个数字 0-9
   • 空格
   • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
   临时 Token 仅作为演示和测试用途，有效期为 24 小时。在生产环境中，你需要自行部署服务器签发 Token，详见生成 RTM Token。

4. 安装依赖项并运行示例项目

按照以下步骤将 Agora SDK 集成到示例项目中。

1. 下载 RTM 仓库，找到 Agora-RTM-Tutorial-Web 示例项目文件夹。

2. 在 Agora-RTM-Tutorial-Web 目录下运行以下命令安装依赖项：

   $ npm install

3. 运行以下命令运行示例项目：

   $ npm run dev

4. 运行成功后，填入 App ID 和 Token，即可正常使用示例项目。

   你必须使用生成 Token 时使用的用户 ID 登录。

运行效果

运行成功后，你会看到如下画面。你可以输入相同的 App ID、Account Name（即用户 ID）和临时 Token，加入同一频道与远端互通。