Skip to content

Commit 792fbd7

Browse files
authored
chore: rename VifChat to Sample Mobile AI Assistant (#106)
1 parent 555be94 commit 792fbd7

26 files changed

Lines changed: 92 additions & 79 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ body:
3030
validations:
3131
required: true
3232
- type: input
33-
id: vifchat-version
33+
id: ai-assistant-version
3434
attributes:
3535
label: App Version
3636
placeholder: e.g. 1.0.0

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
git add .
4141
git config user.name '${{ vars.USER_NAME }}'
4242
git config user.email '${{ vars.USER_EMAIL }}'
43-
git commit -m 'release: VifChat v${{ env.NEW_VERSION }}'
43+
git commit -m 'release: AI Assistant v${{ env.NEW_VERSION }}'
4444
git push
4545
git tag ${{ env.NEW_VERSION }}
4646
git push origin ${{ env.NEW_VERSION }}
@@ -51,7 +51,7 @@ jobs:
5151
- name: Create GitHub release
5252
uses: softprops/action-gh-release@v2
5353
with:
54-
name: "VifChat v${{ env.NEW_VERSION }}"
54+
name: "AI Assistant v${{ env.NEW_VERSION }}"
5555
files: |
5656
react-native/android/app/build/outputs/apk/release/*.apk
5757
tag_name: "${{ env.NEW_VERSION }}"

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,15 @@
22
#
33
.DS_Store
44
.idea
5+
6+
# Swift Package Manager build cache
7+
.build/
8+
react-native/ios/LocalPackages/LiteRT-LM/.build/
9+
assets/test_agent_imgs/
10+
11+
# Python
12+
__pycache__/
13+
*.py[cod]
14+
15+
# Claude Code
16+
.claude/

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Sample Vif Chat App — A Cross-platform AI Assistant
1+
# Sample Mobile AI Assistant — A Cross-platform AI Chat & Creation App
22

33
> 🚀 Your Personal AI Workspace — Chat, Create Apps, and More
44
5-
[![GitHub Release](https://img.shields.io/github/v/release/aws-samples/sample-vif-chat-app)](https://github.com/aws-samples/sample-vif-chat-app/releases)
5+
[![GitHub Release](https://img.shields.io/github/v/release/aws-samples/sample-mobile-ai-assistant)](https://github.com/aws-samples/sample-mobile-ai-assistant/releases)
66
[![License](https://img.shields.io/badge/license-MIT--0-green)](LICENSE)
77

88
[中文](/README_CN.md)
99

10-
VifChat is a fast and responsive AI assistant developed with [React Native](https://reactnative.dev/) and
10+
AI Assistant is a fast and responsive cross-platform app developed with [React Native](https://reactnative.dev/) and
1111
powered by [Amazon Bedrock](https://aws.amazon.com/bedrock/), with compatibility extending to other model providers such
1212
as Ollama, DeepSeek, OpenAI and OpenAI Compatible. With its minimalist design philosophy and robust privacy protection,
1313
it delivers real-time streaming conversations, AI image generation, instant web app creation and voice conversation
@@ -20,7 +20,7 @@ capabilities across Android, iOS, and macOS platforms.
2020
- 🚀 Upgrade to React Native 0.83 with New Architecture enabled (From v2.8.0).
2121
- 🚀 Support create or edit instant web apps with one prompt (From v2.7.0).
2222
- 🚀 Support Web Search for real-time information retrieval (From v2.7.0).
23-
- 🚀 Update VifChat Server with API Gateway + Lambda deployment supporting 15-minute streaming output (From v2.7.0).
23+
- 🚀 Update App Server with API Gateway + Lambda deployment supporting 15-minute streaming output (From v2.7.0).
2424
- 🚀 Support Image Gallery for browsing and managing generated images (From v2.7.0).
2525

2626
**Create App**: Generate, Edit, Share and Preview Instant Web Apps
@@ -65,15 +65,15 @@ You can choose one of the following two methods for configuration
6565
long-term API
6666
key.
6767

68-
2. Copy and paste the API key to the (Amazon Bedrock -> Bedrock API Key) under VifChat Settings page.
68+
2. Copy and paste the API key to the (Amazon Bedrock -> Bedrock API Key) under AI Assistant Settings page.
6969

7070
3. The App will automatically get the latest model list based on the region you currently selected. If multiple models
7171
appear in the list, it means the configuration is successful.
7272

7373
</details>
7474

7575
<details>
76-
<summary><b>🔧 Configure VifChat Server (Click to expand)</b></summary>
76+
<summary><b>🔧 Configure App Server (Click to expand)</b></summary>
7777

7878
### Architecture
7979

@@ -88,30 +88,30 @@ We use **API Gateway** combined with **AWS Lambda** to enable streaming response
8888
**Deploy with one command:**
8989

9090
```bash
91-
curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-vif-chat-app/main/server/install.sh | bash
91+
curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-mobile-ai-assistant/main/server/install.sh | bash
9292
```
9393

94-
By default this deploys to **the account of your current AWS profile**, in the region from `$AWS_REGION` or your `aws configure` default (fallback: `us-east-1`), with stack name `VifChat`. Wait about 3-4 minutes to see your **API URL**, **API Key** obtain link, and a scannable QR code for auto-configuring the app.
94+
By default this deploys to **the account of your current AWS profile**, in the region from `$AWS_REGION` or your `aws configure` default (fallback: `us-east-1`), with stack name `AIAssistant`. Wait about 3-4 minutes to see your **API URL**, **API Key** obtain link, and a scannable QR code for auto-configuring the app.
9595

9696
To target a different account, region, or stack:
9797

9898
```bash
99-
./install.sh --region us-west-2 --stack MyVifChat --profile myprofile
99+
./install.sh --region us-west-2 --stack MyAIAssistant --profile myprofile
100100
```
101101

102102
| Flag | Purpose | Default |
103103
|---|---|---|
104104
| `--region` | AWS region to deploy into | `$AWS_REGION` or `us-east-1` |
105-
| `--stack` | CloudFormation stack name | `VifChat` |
105+
| `--stack` | CloudFormation stack name | `AIAssistant` |
106106
| `--profile` | AWS CLI profile to use | current default profile |
107107

108108
### Step 2: Open the App and setup with API URL and API Key
109109

110110
1. Launch the App, open the drawer menu, and tap **Settings**.
111-
2. Under Amazon Bedrock → VifChat Server, tap the scan icon next to **API URL** to scan the QR (iOS/Android) — or paste `API URL` and `API Key` manually.
111+
2. Under Amazon Bedrock → App Server, tap the scan icon next to **API URL** to scan the QR (iOS/Android) — or paste `API URL` and `API Key` manually.
112112
3. Select your Region, then tap the top right ✓ to save.
113113

114-
Congratulations 🎉 Your VifChat App is ready to use!
114+
Congratulations 🎉 Your AI Assistant App is ready to use!
115115

116116
</details>
117117

@@ -173,7 +173,7 @@ Congratulations 🎉 Your VifChat App is ready to use!
173173
- `GPT-4o`
174174
- `GPT-4o mini`
175175

176-
Additionally, if you have deployed and configured the [VifChat Server](#getting-started-with-amazon-bedrock), you
176+
Additionally, if you have deployed and configured the [App Server](#getting-started-with-amazon-bedrock), you
177177
can enable the **Use Proxy** option to forward your requests.
178178

179179
</details>
@@ -281,7 +281,7 @@ https://github.com/user-attachments/assets/ebf21b12-9c93-4d2e-a109-1d6484019838
281281

282282
https://github.com/user-attachments/assets/c70fc2b4-8960-4a5e-b4f8-420fcd5eafd4
283283

284-
> Note: Amazon Nova Sonic currently only available with VifChat server.
284+
> Note: Amazon Nova Sonic currently only available with App Server.
285285

286286
#### Other Features
287287

@@ -341,7 +341,7 @@ landscape orientation.
341341

342342
![](assets/animations/landscape.avif)
343343

344-
## What Makes VifChat Really "Vif"?
344+
## What Makes AI Assistant Really Fast?
345345

346346
🚀 **Fast Launch Speed**
347347

@@ -403,7 +403,7 @@ npm run ios
403403
### Build for macOS
404404

405405
1. Execute `npm start`.
406-
2. Double click `ios/VifChat.xcworkspace` to open the project in your Xcode.
406+
2. Double click `ios/AIAssistant.xcworkspace` to open the project in your Xcode.
407407
3. Change the build destination to `My Mac (Mac Catalyst)` then click the ▶ Run button.
408408

409409
## API Reference
@@ -416,11 +416,11 @@ Please refer [API Reference](server/README.md)
416416

417417
- **Android** and **macOS**: Navigate to **Settings** Page, if there is a new version, you will find it at the bottom
418418
of this page, then click the app version to download and install it.
419-
- **iOS**: If a new version is released in the [Release page](https://github.com/aws-samples/sample-vif-chat-app/releases),
419+
- **iOS**: If a new version is released in the [Release page](https://github.com/aws-samples/sample-mobile-ai-assistant/releases),
420420
update your local code, rebuild and install your app by Xcode.
421421

422422
**Note**: After downloading a new version, please check
423-
the [release notes](https://github.com/aws-samples/sample-vif-chat-app/releases) to see if an API version update is required.
423+
the [release notes](https://github.com/aws-samples/sample-mobile-ai-assistant/releases) to see if an API version update is required.
424424

425425
### Upgrade API
426426

README_CN.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Sample Vif Chat App — 跨平台 AI 助手
1+
# Sample Mobile AI Assistant — 跨平台 AI 对话与创作应用
22

33
> 🚀 您的个人 AI 工作空间 — 聊天、创建应用等
44
5-
[![GitHub Release](https://img.shields.io/github/v/release/aws-samples/sample-vif-chat-app)](https://github.com/aws-samples/sample-vif-chat-app/releases)
5+
[![GitHub Release](https://img.shields.io/github/v/release/aws-samples/sample-mobile-ai-assistant)](https://github.com/aws-samples/sample-mobile-ai-assistant/releases)
66
[![License](https://img.shields.io/badge/license-MIT--0-green)](LICENSE)
77

88
[English](/README.md)
99

10-
VifChat 是一款快速响应的 AI 助手,采用 [React Native](https://reactnative.dev/)
10+
AI Assistant 是一款快速响应的跨平台应用,采用 [React Native](https://reactnative.dev/)
1111
开发,并依托 [Amazon Bedrock](https://aws.amazon.com/bedrock/) 提供强大支持,同时兼容 Ollama、DeepSeek、OpenAI 和 OpenAI
1212
兼容的其他模型供应商。凭借其极简设计理念与坚实的隐私保护措施,该应用在 Android、iOS 和 macOS 平台上实现了实时流式对话、AI
1313
图像生成、极速 Web 应用创建和语音对话功能。
@@ -19,7 +19,7 @@ VifChat 是一款快速响应的 AI 助手,采用 [React Native](https://react
1919
- 🚀 升级至 React Native 0.83,启用 New Architecture(自 v2.8.0 起)。
2020
- 🚀 支持一句话创建或编辑极速 Web 应用(自 v2.7.0 起)。
2121
- 🚀 支持网络搜索,获取实时信息(自 v2.7.0 起)。
22-
- 🚀 更新 VifChat 服务器,支持 API Gateway + Lambda 部署,最长支持 15 分钟流式输出(自 v2.7.0 起)。
22+
- 🚀 更新 App 服务器,支持 API Gateway + Lambda 部署,最长支持 15 分钟流式输出(自 v2.7.0 起)。
2323
- 🚀 支持图片画廊,浏览和管理生成的图片(自 v2.7.0 起)。
2424

2525
**创建应用**:生成、编辑、分享和预览极速 Web 应用
@@ -62,14 +62,14 @@ VifChat 是一款快速响应的 AI 助手,采用 [React Native](https://react
6262

6363
1. 点击 [Amazon Bedrock 控制台](https://console.aws.amazon.com/bedrock/home#/api-keys/long-term/create) 创建长期 API 密钥。
6464

65-
2. 复制并粘贴 API 密钥到 VifChat 设置页面的(Amazon Bedrock -> Bedrock API Key)中。
65+
2. 复制并粘贴 API 密钥到 AI Assistant 设置页面的(Amazon Bedrock -> Bedrock API Key)中。
6666

6767
3. 应用程序将根据您当前选择的区域自动获取最新的模型列表。如果列表中出现多个模型,说明配置成功。
6868

6969
</details>
7070

7171
<details>
72-
<summary><b>🔧 配置 VifChat 服务器(点击展开)</b></summary>
72+
<summary><b>🔧 配置 App 服务器(点击展开)</b></summary>
7373

7474
### 架构
7575

@@ -84,30 +84,30 @@ VifChat 是一款快速响应的 AI 助手,采用 [React Native](https://react
8484
**一行命令部署:**
8585

8686
```bash
87-
curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-vif-chat-app/main/server/install.sh | bash
87+
curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-mobile-ai-assistant/main/server/install.sh | bash
8888
```
8989

90-
默认部署到**当前 AWS profile 的账户**,region 取 `$AWS_REGION``aws configure` 的默认值(都未设置则为 `us-east-1`),堆栈名为 `VifChat`。等待约 3-4 分钟,您会看到 **API URL****API Key** 获取链接,以及可用手机扫描自动配置的二维码。
90+
默认部署到**当前 AWS profile 的账户**,region 取 `$AWS_REGION``aws configure` 的默认值(都未设置则为 `us-east-1`),堆栈名为 `AIAssistant`。等待约 3-4 分钟,您会看到 **API URL****API Key** 获取链接,以及可用手机扫描自动配置的二维码。
9191

9292
需要指定其他目标时:
9393

9494
```bash
95-
./install.sh --region us-west-2 --stack MyVifChat --profile myprofile
95+
./install.sh --region us-west-2 --stack MyAIAssistant --profile myprofile
9696
```
9797

9898
| 参数 | 作用 | 默认值 |
9999
|---|---|---|
100100
| `--region` | 部署到的 AWS region | `$AWS_REGION``us-east-1` |
101-
| `--stack` | CloudFormation 堆栈名 | `VifChat` |
101+
| `--stack` | CloudFormation 堆栈名 | `AIAssistant` |
102102
| `--profile` | 使用的 AWS CLI profile | 当前默认 profile |
103103

104104
### 步骤 2:打开应用并使用 API URL 和 API Key 进行设置
105105

106106
1. 启动应用,打开抽屉菜单,点击 **设置**
107-
2. 在 Amazon Bedrock → VifChat Server 下,点击 **API URL** 右侧的扫码图标扫描二维码(iOS/Android),或手动粘贴 `API URL``API Key`
107+
2. 在 Amazon Bedrock → App Server 下,点击 **API URL** 右侧的扫码图标扫描二维码(iOS/Android),或手动粘贴 `API URL``API Key`
108108
3. 选择 Region,然后点击右上角 ✓ 保存。
109109

110-
恭喜 🎉 您的 VifChat 应用已准备就绪!
110+
恭喜 🎉 您的 AI Assistant 应用已准备就绪!
111111

112112
</details>
113113

@@ -168,7 +168,7 @@ curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-vif-chat-app/mai
168168
- `GPT-4o`
169169
- `GPT-4o mini`
170170

171-
此外,如果您已部署并配置了 [VifChat 服务器](#amazon-bedrock-入门指南),可以启用 **Use Proxy** 选项来转发您的请求。
171+
此外,如果您已部署并配置了 [App 服务器](#amazon-bedrock-入门指南),可以启用 **Use Proxy** 选项来转发您的请求。
172172

173173
</details>
174174

@@ -271,7 +271,7 @@ https://github.com/user-attachments/assets/ebf21b12-9c93-4d2e-a109-1d6484019838
271271

272272
https://github.com/user-attachments/assets/c70fc2b4-8960-4a5e-b4f8-420fcd5eafd4
273273

274-
> 注意:Amazon Nova Sonic 目前仅在 VifChat 服务器中可用。
274+
> 注意:Amazon Nova Sonic 目前仅在 App 服务器中可用。
275275

276276
#### 其他功能
277277

@@ -329,7 +329,7 @@ https://github.com/user-attachments/assets/c70fc2b4-8960-4a5e-b4f8-420fcd5eafd4
329329

330330
![](assets/animations/landscape.avif)
331331

332-
## 什么让 VifChat 真正"Vif"
332+
## 什么让 AI Assistant 如此快速
333333

334334
🚀 **快速启动速度**
335335

@@ -389,7 +389,7 @@ npm run ios
389389
### 构建 macOS
390390

391391
1. 执行 `npm start`
392-
2. 双击 `ios/VifChat.xcworkspace` 在 Xcode 中打开项目。
392+
2. 双击 `ios/AIAssistant.xcworkspace` 在 Xcode 中打开项目。
393393
3. 将构建目标更改为 `My Mac (Mac Catalyst)` 然后点击 ▶ 运行按钮。
394394

395395
## API 参考
@@ -401,10 +401,10 @@ npm run ios
401401
### 升级应用
402402

403403
- **Android****macOS**:导航到 **设置** 页面,如果有新版本,您将在此页面底部找到它,然后点击应用版本下载并安装。
404-
- **iOS**:如果在 [发布页面](https://github.com/aws-samples/sample-vif-chat-app/releases) 发布了新版本,请更新您的本地代码,通过
404+
- **iOS**:如果在 [发布页面](https://github.com/aws-samples/sample-mobile-ai-assistant/releases) 发布了新版本,请更新您的本地代码,通过
405405
Xcode 重新构建并安装您的应用。
406406

407-
**注意**:下载新版本后,请查看 [发布说明](https://github.com/aws-samples/sample-vif-chat-app/releases) 确认是否需要 API 版本更新。
407+
**注意**:下载新版本后,请查看 [发布说明](https://github.com/aws-samples/sample-mobile-ai-assistant/releases) 确认是否需要 API 版本更新。
408408

409409
### 升级 API
410410

react-native/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# VifChat React Native
1+
# AI Assistant React Native
22

33
## Tech Stack
44

react-native/android/app/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ android {
110110
variant.outputs.each { output ->
111111
def outputFile = output.outputFile
112112
if (outputFile != null && outputFile.name.endsWith('.apk')) {
113-
def fileName = "VifChat.apk"
113+
def fileName = "AIAssistant.apk"
114114
output.outputFileName = fileName
115115
}
116116
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<resources>
2-
<string name="app_name">VifChat</string>
2+
<string name="app_name">AI Assistant</string>
33
</resources>

react-native/ios/VifChat.xcworkspace/contents.xcworkspacedata renamed to react-native/ios/AIAssistant.xcworkspace/contents.xcworkspacedata

File renamed without changes.

react-native/ios/VifChat.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist renamed to react-native/ios/AIAssistant.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

File renamed without changes.

0 commit comments

Comments
 (0)