diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.md b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.md index 761770c8..6dffceb0 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.md +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.md @@ -1,4 +1,4 @@ -# Web Tutorial for webpack - 1to1 +# Web Tutorial For Webpack - 1to1 *English | [中文](README.zh.md)* @@ -16,9 +16,11 @@ This section shows you how to prepare, and run the sample application. ### Obtain an App ID To build and run the sample application, get an App ID: -1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). -2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation. -3. Copy the **App ID** from the Dashboard. +1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard. +2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**. +3. Save the **App ID** from the Dashboard for later use. +4. Generate a temp **Access Token** (valid for 24 hours) from dashboard page with given channel name, save for later use. + ### Install dependencies and integrate the Agora Video SDK diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.yaml b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.yaml index e0eea0b9..b0c28f94 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.yaml +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.yaml @@ -13,10 +13,7 @@ QuickStart: sections: - title: Obtain an App ID content: | - To build and run the sample application, get an App ID: - 1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). - 2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation. - 3. Copy the **App ID** from the Dashboard. + $_{APPID} - title: Install dependencies and integrate the Agora Video SDK content: | 1. Using the Terminal app, enter the `install` command in your project directory. This command installs libraries that are required to run the sample application. diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.md b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.md index 876c01bd..658a668e 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.md +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.md @@ -24,6 +24,8 @@ This section shows you how to prepare, and run the sample application. 1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号 2. 前往后台页面,点击左部导航栏的 **项目 > 项目列表** 菜单 3. 复制后台的 **App ID** 并备注,稍后启动应用时会用到它 +4. 在项目页面生成临时 **Access Token** (24小时内有效)并备注,注意生成的Token只能适用于对应的频道名。 + ### 集成 Agora 视频 SDK diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.yaml b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.yaml index f8f3f1bf..4237380c 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.yaml +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack/README.zh.yaml @@ -19,10 +19,7 @@ QuickStart: sections: - title: 创建Agora账号并获取AppId content: | - 在编译和启动实例程序前,您需要首先获取一个可用的App ID: - 1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号 - 2. 前往后台页面,点击左部导航栏的 **项目 > 项目列表** 菜单 - 3. 复制后台的 **App ID** 并备注,稍后启动应用时会用到它 + $_{APPID} - title: 集成 Agora 视频 SDK content: | 1. 在Terminal中,在您的项目根目录输入`install`命令以安装项目依赖 diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.md b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.md index fc3db2dc..f6169c39 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.md +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.md @@ -15,14 +15,27 @@ This section shows you how to prepare, and run the sample application. ### Obtain an App ID To build and run the sample application, get an App ID: -1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). -2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation. -3. Copy the **App ID** from the Dashboard. -4. Download SDK into **assets** path and rename file name as **AgoraRTCSDK-2.6.1.js** +1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the signup process, you will be redirected to the Dashboard. +2. Navigate in the Dashboard tree on the left to **Projects** > **Project List**. +3. Save the **App ID** from the Dashboard for later use. +4. Generate a temp **Access Token** (valid for 24 hours) from dashboard page with given channel name, save for later use. + ### Intergrate Agora Video SDK -1. Open **index.html** file by web browser. Then Enter Valid APPID, Channel, UID and click **Join Room** +Download SDK into **assets** path and rename file name as **AgoraRTCSDK-2.6.1.js** + +### Run Web-Server + +1. Install live-server globally via npm + ``` + npm i live-server -g + ``` +2. Launch server via following commands in working folder, + ``` + live-server . + ``` +3. Enter Valid APPID, Token, Channel, UID and click **Join Room** ## Resources diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.yaml b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.yaml index 192b144f..1cbbb53e 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.yaml +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.yaml @@ -12,14 +12,21 @@ QuickStart: sections: - title: Obtain an App ID content: | - To build and run the sample application, get an App ID: - 1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). - 2. In the Dashboard that opens, click **Projects** > **Project List** in the left navigation. - 3. Copy the **App ID** from the Dashboard. - 4. Download SDK into **assets** path and rename file name as **AgoraRTCSDK-2.6.1.js** + $_{APPID} - title: Intergrate Agora Video SDK content: | - 1. Open **index.html** file by web browser. Then Enter Valid APPID, Channel, UID and click **Join Room** + Download SDK into **assets** path and rename file name as **AgoraRTCSDK-2.6.1.js** + - title: Run Web-Server + content: | + 1. Install live-server globally via npm + ``` + npm i live-server -g + ``` + 2. Launch server via following commands in working folder, + ``` + live-server . + ``` + 3. Enter Valid APPID, Token, Channel, UID and click **Join Room** Resources: document: https://docs.agora.io/en/ issue: https://github.com/AgoraIO/Basic-Video-Call/issues diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.md b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.md index 54aaa950..93d22260 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.md +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.md @@ -23,11 +23,24 @@ 1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号 2. 前往后台页面,点击左部导航栏的 **项目 > 项目列表** 菜单 3. 复制后台的 **App ID** 并备注,稍后启动应用时会用到它 -4. 下载SDK到 **assets**目录,并改名为**AgoraRTCSDK-2.6.1.js** +4. 在项目页面生成临时 **Access Token** (24小时内有效)并备注,注意生成的Token只能适用于对应的频道名。 + ### 集成 Agora 视频 SDK -1. 用浏览器打开 index.html 文件,在对应的输入框里正确输入 APPID, Channel, UID。点击Join Room即可。 +下载SDK到 **assets**目录,并改名为**AgoraRTCSDK-2.6.1.js** + +### 启动Web-Server + +1. 安装live-server + ``` + npm i live-server -g + ``` +2. 在工作目录通过以下命令启动live-server服务器, + ``` + live-server . + ``` +3. 在对应的输入框里正确输入 APPID, Token, Channel, UID。点击Join Room即可。 ## 联系我们 diff --git a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.yaml b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.yaml index 8db15686..21a17e1a 100644 --- a/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.yaml +++ b/One-to-One-Video/Agora-Web-Tutorial-1to1/README.zh.yaml @@ -18,14 +18,21 @@ QuickStart: sections: - title: 创建Agora账号并获取AppId content: | - 在编译和启动实例程序前,您需要首先获取一个可用的App ID: - 1. 在[agora.io](https://dashboard.agora.io/signin/)创建一个开发者账号 - 2. 前往后台页面,点击左部导航栏的 **项目 > 项目列表** 菜单 - 3. 复制后台的 **App ID** 并备注,稍后启动应用时会用到它 - 4. 下载SDK到 **assets**目录,并改名为**AgoraRTCSDK-2.6.1.js** + $_{APPID} - title: 集成 Agora 视频 SDK content: | - 1. 用浏览器打开 index.html 文件,在对应的输入框里正确输入 APPID, Channel, UID。点击Join Room即可。 + 下载SDK到 **assets**目录,并改名为**AgoraRTCSDK-2.6.1.js** + - title: 启动Web-Server + content: | + 1. 安装live-server + ``` + npm i live-server -g + ``` + 2. 在工作目录通过以下命令启动live-server服务器, + ``` + live-server . + ``` + 3. 在对应的输入框里正确输入 APPID, Token, Channel, UID。点击Join Room即可。 Resources: document: https://docs.agora.io/cn/ issue: https://github.com/AgoraIO/Basic-Video-Call/issues diff --git a/gen_readme_all.sh b/gen_readme_all.sh index 48179df9..3a07d867 100755 --- a/gen_readme_all.sh +++ b/gen_readme_all.sh @@ -11,4 +11,6 @@ ./gen_readme.sh ./One-to-One-Video/Agora-iOS-Tutorial-Swift-1to1 ./gen_readme.sh ./One-to-One-Video/Agora-macOS-Tutorial-Objective-C-1to1 ./gen_readme.sh ./One-to-One-Video/Agora-macOS-Tutorial-Swift-1to1 +./gen_readme.sh ./One-to-One-Video/Agora-Web-Tutorial-1to1 +./gen_readme.sh ./One-to-One-Video/Agora-Web-Tutorial-1to1-Webpack ./gen_readme.sh ./One-to-One-Video/Agora-Windows-Tutorial-1to1 \ No newline at end of file