Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions Chat-Web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,44 @@ The project uses a single app to combine a variety of functionalities.

- A valid Agora Chat developer account.
- [Create the Agora Chat project and get the AppKey](https://docs-im.easemob.com/im/quickstart/guide/experience) 。
- A registered Agora Chat user ID and an access token for that user.
- [npm](https://www.npmjs.com/get-npm)
- SDK supports Internet explorer 9+, FireFox10+, Chrome54+, Safari6+ text, expression, picture, audio, address messages sent to each other.

### Steps to run

1. Install dependencies
1. Configure AppId
Before running the project, first configure your Agora Chat AppId in the `Agora-Chat-API-Examples/Chat-Web/src/index.js` file:

```javascript
WebIM.conn = new WebIM.connection({
appId: "your appId", // Replace with your Agora Chat SDK App ID
});
```

Replace `"your appId"` with your actual AppId obtained from the Agora console.

The sample project no longer includes a registration or password-login service. After starting the app, enter a registered User ID and that user's access token to log in.

2. Install dependencies

```bash
npm install
```

2. Packaging project
3. Packaging project

```bash
npm run build
```

3. Start the project
4. Start the project

```bash
npm run start:dev
```

4. Open your browser to https://localhost:9000 and run the project.
5. Open your browser to https://localhost:9000 and run the project.

You are all set! Feel free to play with this sample project and explore features of the Agora Chat SDK.

Expand Down
22 changes: 18 additions & 4 deletions Chat-Web/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,44 @@ _[English](README.md) | 中文_

- 有效的 Agora Chat 开发者账号。
- [创建 Agora Chat 项目并获取 AppKey](https://docs-im.easemob.com/im/quickstart/guide/experience) 。
- 一个已注册的 Agora Chat 用户 ID,以及该用户对应的访问 token。
- [npm](https://www.npmjs.com/get-npm)
- SDK 支持 IE9+、FireFox10+、Chrome54+、Safari6+ 之间文本、表情、图片、音频、地址消息相互发送。

### 运行步骤

1. 安装依赖
1. 配置 AppId
在运行项目之前,首先需要在 `Agora-Chat-API-Examples/Chat-Web/src/index.js` 文件中配置你的 Agora Chat AppId:

```javascript
WebIM.conn = new WebIM.connection({
appId: "your appId", // 替换为你的 Agora Chat SDK App ID
});
```

将 `"your appId"` 替换为你在 Agora 控制台获取的实际 AppId。

示例项目不再内置注册或密码登录服务。启动后请在页面中输入已注册的 User ID 和该用户的 access token 后登录。

2. 安装依赖

```bash
npm install
```

2. 打包项目
3. 打包项目

```bash
npm run build
```

3. 启动项目
4. 启动项目

```bash
npm run start:dev
```

4. 浏览器打开 https://localhost:9000 运行项目。
5. 浏览器打开 https://localhost:9000 运行项目。

一切就绪。你可以自由探索示例项目,体验 Agora Chat SDK 的丰富功能。

Expand Down
2 changes: 2 additions & 0 deletions Chat-Web/chat-uikit/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
registry=https://registry.npmmirror.com/
strict-ssl=true
21 changes: 18 additions & 3 deletions Chat-Web/chat-uikit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,22 @@ The project uses a single app to combine a variety of functionalities.

### Steps to run

1. Install dependencies
1. Configure AppId
Before running the project, first configure your Agora Chat AppId in the `Agora-Chat-API-Examples/Chat-Web/chat-uikit/src/index.js` file:

```javascript
<Provider
initConfig={{
appId: "your appId", // Replace with your Agora Chat SDK App ID
}}
>
```

Replace `"your appId"` with your actual AppId obtained from the Agora console.

The sample project no longer includes a password-login service. After starting the app, enter a registered User ID and that user's access token to log in.

2. Install dependencies

npm
```bash
Expand All @@ -33,7 +48,7 @@ yarn
yarn
```

2. Start the project
3. Start the project

npm
```bash
Expand All @@ -45,7 +60,7 @@ yarn
yarn start
```

3. Open your browser to http://localhost:3000 and run the project.
4. Open your browser to http://localhost:3000 and run the project.

You are all set! Feel free to play with this sample project and explore features of the Agora Chat UIKIT.

Expand Down
21 changes: 18 additions & 3 deletions Chat-Web/chat-uikit/README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,22 @@ _[English](README.md) | 中文_

### 运行步骤

1. 安装依赖
1. 配置 AppId
在运行项目之前,首先需要在 `Agora-Chat-API-Examples/Chat-Web/chat-uikit/src/index.js` 文件中配置你的 Agora Chat AppId:

```javascript
<Provider
initConfig={{
appId: "your appId", // 替换为你的 Agora Chat SDK App ID
}}
>
```

将 `"your appId"` 替换为你在 Agora 控制台获取的实际 AppId。

示例项目不再内置密码登录服务。启动后请在页面中输入已注册的 User ID 和该用户的 access token 后登录。

2. 安装依赖

npm
```bash
Expand All @@ -33,7 +48,7 @@ yarn
yarn
```

2. 启动项目
3. 启动项目

npm
```bash
Expand All @@ -45,7 +60,7 @@ yarn
yarn start
```

3. 浏览器打开 http://localhost:3000/ 运行项目。
4. 浏览器打开 http://localhost:3000/ 运行项目。

一切就绪。你可以自由探索示例项目,体验 Agora Chat UIKIT 的丰富功能。

Expand Down
Loading