Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme cn update #136

Merged
merged 4 commits into from
Jul 30, 2024
Merged

Readme cn update #136

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48b8501
Update README-CN.md
cyfyifanchen Jul 30, 2024
d6ab5d1
Update README-CN.md
cyfyifanchen Jul 30, 2024
457abfa
Merge remote-tracking branch 'upstream/main' into readme-cn-update
cyfyifanchen Jul 30, 2024
0130795
Update README-CN.md
cyfyifanchen Jul 30, 2024
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
18 changes: 10 additions & 8 deletions docs/readmes/README-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ $ go env -w GOPROXY=https://goproxy.cn,direct
```

#### 1.创建 manifest 配置文件
从示例文件创建 manifest：
从示例文件创建 `manifest.json`：

```bash
cp ./agents/manifest.json.example ./agents/manifest.json
```

#### 2. 基本配置

在 manifest 里面找到下列属性替换：
在 `manifest.json` 里面找到下列属性替换：
```json
"app_id": "<agora_appid>"
"api_key": "<openai_api_key>"
Expand All @@ -83,7 +83,7 @@ cp ./agents/manifest.json.example ./agents/manifest.json
```

#### 3. 定制化
在 manifest 可以直接改 propmt 和问候语：
在 `manifest.json` 可以直接改 propmt 和问候语：
```json
"property": {
"base_url": "",
Expand All @@ -98,7 +98,7 @@ cp ./agents/manifest.json.example ./agents/manifest.json
}
```

#### 4. 在 Docker 镜像中构建 agent
#### 4. 在 Docker 容器中构建 agent

打开 Terminal， 跑下列命令：

Expand All @@ -118,22 +118,24 @@ make build

#### 5. 启动本地服务器


在容器里启动本地服务器, 端口是 8080：
```bash
# Agent is ready to start on port 8080
# 端口 8080
make run-server
```

#### 6. 运行 voice agent 界面

voice agent 界面是基于 NextJS 14 构建的，因此需要 Node 18 或更高版本。
Voice agent 界面是基于 NextJS 14 构建的，因此需要 Node 18 或更高版本。

同时，再打开一个 Terminal 窗口， 通过下列命令创建环境文件并跑起界面。

```bash
# 创建一个本地的环境文件
cd playground
cp .env.example .env

# 安装依赖
# 安装依赖并开启界面
npm install && npm run dev
```

Expand Down