Skip to content

Commit 8fa0620

Browse files
committed
docs: update README_CN.md
1 parent c4200f1 commit 8fa0620

File tree

2 files changed

+38
-17
lines changed

2 files changed

+38
-17
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examp
131131
acknowledge that AWS CloudFormation might create IAM resources" checkbox at the bottom.
132132
5. Click **Next**, In the "Review and create" Review your configuration and click **Submit**.
133133

134-
Wait about 10-15 minutes for the deployment to finish, then click the CloudFormation stack and go to **Outputs** tab, you
134+
Wait about 3–5 minutes for the deployment to finish, then click the CloudFormation stack and go to **Outputs** tab, you
135135
can find the **API URL** which looks like: `https://xxx.xxx.awsapprunner.com` or `https://xxx.lambda-url.xxx.on.aws`
136136

137137
### Step 4: Open the App and setup with API URL and API Key

README_CN.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -74,36 +74,57 @@ SwiftChat 是一款快速响应的 AI 聊天应用,采用 [React Native](https
7474
2. 检查您是否在 [支持的区域](#支持的区域),然后点击 **创建参数** 按钮。
7575
3. 填入以下参数,其他选项保持默认:
7676

77-
- **名称**:输入参数名称(例如 "SwiftChatAPIKey",将在步骤 2 中用作 `ApiKeyParam`)。
77+
- **名称**:输入参数名称(例如 "SwiftChatAPIKey",将在步骤 3 中用作 `ApiKeyParam`)。
7878

7979
- **类型**:选择 `SecureString`
8080

81-
- ****:输入任何不含空格的字符串(这将是步骤 3 中您的 `API Key`
81+
- ****:输入任何不含空格的字符串(这将是步骤 4 中您的 `API Key`
8282

8383
4. 点击 **创建参数**
8484

85-
### 步骤 2:部署堆栈并获取 API URL
85+
### 步骤 2:构建并推送容器镜像到 ECR
8686

87-
1. 前往 [CloudFormation 控制台](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChat),在**指定模板**下选择**上传模板文件**,然后使用以下模板之一进行部署。(确保您所在的区域与创建 API Key 的区域相同。)
87+
1. 克隆此仓库:
88+
```bash
89+
git clone https://github.com/aws-samples/swift-chat.git
90+
cd swift-chat
91+
```
8892

89-
- **App Runner**
93+
2. 运行构建和推送脚本:
94+
```bash
95+
cd server/scripts
96+
bash ./push-to-ecr.sh
97+
```
9098

91-
打开 [SwiftChatAppRunner.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatAppRunner.template),然后下载并上传文件。
99+
3. 按照提示进行配置:
100+
- ECR 仓库名称(或使用默认值:`swift-chat-api`
101+
- 镜像标签(或使用默认值:`latest`
102+
- AWS 区域(或使用默认值:`us-east-1`
92103

93-
- **Lambda**(注意:仅供 AWS 客户使用)
104+
4. 脚本将构建并推送 Docker 镜像到您的 ECR 仓库。
94105

95-
打开 [SwiftChatLambda.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatLambda.template),然后下载并上传文件
106+
5. **重要**:复制脚本输出末尾显示的镜像 URI。您将在下一步中需要它
96107

97-
2. 点击 **下一步**,在"指定堆栈详细信息"页面,提供以下信息:
98-
- 用您存储 API 密钥的参数名称填写 `ApiKeyParam`(例如 "SwiftChatAPIKey")。
99-
- 对于 App Runner,根据您的需求选择 `InstanceTypeParam`
100-
3. 点击 **下一步**,保持"配置堆栈选项"页面为默认,阅读功能并勾选底部的"我确认 AWS CloudFormation 可能会创建 IAM 资源"复选框。
101-
4. 点击 **下一步**,在"审核并创建"中检查您的配置并点击 **提交**
108+
### 步骤 3:部署堆栈并获取 API URL
102109

103-
等待约 3-5 分钟完成部署,然后点击 CloudFormation 堆栈并转到 **输出** 选项卡,您可以找到类似
104-
`https://xxx.xxx.awsapprunner.com``https://xxx.lambda-url.xxx.on.aws`**API URL**
110+
1. 下载您想使用的 CloudFormation 模板:
111+
- App Runner:[SwiftChatAppRunner.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatAppRunner.template)
112+
- Lambda:[SwiftChatLambda.template](https://github.com/aws-samples/swift-chat/blob/main/server/template/SwiftChatLambda.template)
105113

106-
### 步骤 3:打开应用并使用 API URL 和 API Key 进行设置
114+
2. 前往 [CloudFormation 控制台](https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatAPI),在**指定模板**下选择**上传模板文件**,然后上传您下载的模板文件。(确保您所在的区域与创建 API Key 的区域相同。)
115+
116+
3. 点击 **下一步**,在"指定堆栈详细信息"页面,提供以下信息:
117+
- **Stack name**:保持默认的 "SwiftChatAPI" 或根据需要更改
118+
- **ApiKeyParam**:输入您用于存储 API 密钥的参数名称(例如 "SwiftChatAPIKey")
119+
- **ContainerImageUri**:输入步骤 2 输出的 ECR 镜像 URI
120+
- 对于 App Runner,根据您的需求选择 **InstanceTypeParam**
121+
122+
4. 点击 **下一步**,保持"配置堆栈选项"页面为默认,阅读功能并勾选底部的"我确认 AWS CloudFormation 可能会创建 IAM 资源"复选框。
123+
5. 点击 **下一步**,在"审核并创建"中检查您的配置并点击 **提交**
124+
125+
等待约 3-5 分钟完成部署,然后点击 CloudFormation 堆栈并转到 **输出** 选项卡,您可以找到 **API URL**,类似于:`https://xxx.xxx.awsapprunner.com``https://xxx.lambda-url.xxx.on.aws`
126+
127+
### 步骤 4:打开应用并使用 API URL 和 API Key 进行设置
107128

108129
1. 启动应用,打开抽屉菜单,点击 **设置**
109130
2. 粘贴 `API URL``API Key`(您在 Parameter Store 中输入的 ****)到 Amazon Bedrock -> SwiftChat Server 下,然后选择您的区域。

0 commit comments

Comments
 (0)