Skip to content

Commit b061ba3

Browse files
authored
chore: rename CloudFormation stack and iOS workspace to VifChat (#102)
1 parent 14063ba commit b061ba3

9 files changed

Lines changed: 15 additions & 11 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,18 +97,18 @@ We use **API Gateway** combined with **AWS Lambda** to enable streaming response
9797
curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-vif-chat-app/main/server/install.sh | bash
9898
```
9999

100-
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 `SwiftChat`. Wait about 3-4 minutes to see your **API URL**, **API Key** obtain link, and a scannable QR code for auto-configuring the app.
100+
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.
101101

102102
To target a different account, region, or stack:
103103

104104
```bash
105-
./install.sh --region us-west-2 --stack MySwiftChat --profile myprofile
105+
./install.sh --region us-west-2 --stack MyVifChat --profile myprofile
106106
```
107107

108108
| Flag | Purpose | Default |
109109
|---|---|---|
110110
| `--region` | AWS region to deploy into | `$AWS_REGION` or `us-east-1` |
111-
| `--stack` | CloudFormation stack name | `SwiftChat` |
111+
| `--stack` | CloudFormation stack name | `VifChat` |
112112
| `--profile` | AWS CLI profile to use | current default profile |
113113

114114
### Step 2: Open the App and setup with API URL and API Key
@@ -409,7 +409,7 @@ npm run ios
409409
### Build for macOS
410410

411411
1. Execute `npm start`.
412-
2. Double click `ios/SwiftChat.xcworkspace` to open the project in your Xcode.
412+
2. Double click `ios/VifChat.xcworkspace` to open the project in your Xcode.
413413
3. Change the build destination to `My Mac (Mac Catalyst)` then click the ▶ Run button.
414414

415415
## API Reference

README_CN.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,18 +93,18 @@ VifChat 是一款快速响应的 AI 助手,采用 [React Native](https://react
9393
curl -fsSL https://raw.githubusercontent.com/aws-samples/sample-vif-chat-app/main/server/install.sh | bash
9494
```
9595

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

9898
需要指定其他目标时:
9999

100100
```bash
101-
./install.sh --region us-west-2 --stack MySwiftChat --profile myprofile
101+
./install.sh --region us-west-2 --stack MyVifChat --profile myprofile
102102
```
103103

104104
| 参数 | 作用 | 默认值 |
105105
|---|---|---|
106106
| `--region` | 部署到的 AWS region | `$AWS_REGION``us-east-1` |
107-
| `--stack` | CloudFormation 堆栈名 | `SwiftChat` |
107+
| `--stack` | CloudFormation 堆栈名 | `VifChat` |
108108
| `--profile` | 使用的 AWS CLI profile | 当前默认 profile |
109109

110110
### 步骤 2:打开应用并使用 API URL 和 API Key 进行设置
@@ -395,7 +395,7 @@ npm run ios
395395
### 构建 macOS
396396

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

401401
## API 参考

assets/architecture.png

8.08 KB
Loading

react-native/ios/Podfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ require Pod::Executable.execute_command('node', ['-p',
1717
platform :ios, min_ios_version_supported
1818
prepare_react_native_project!
1919

20+
# Pin the generated workspace name (the .xcodeproj is still SwiftChat, so without
21+
# this `pod install` would regenerate a SwiftChat.xcworkspace).
22+
workspace 'VifChat'
23+
2024
linkage = ENV['USE_FRAMEWORKS']
2125
if linkage != nil
2226
Pod::UI.puts "Configuring Pod with #{linkage}ally linked Frameworks".green

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

File renamed without changes.

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

File renamed without changes.

react-native/ios/SwiftChat.xcworkspace/xcshareddata/swiftpm/Package.resolved renamed to react-native/ios/VifChat.xcworkspace/xcshareddata/swiftpm/Package.resolved

File renamed without changes.

react-native/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"scripts": {
77
"android": "react-native run-android",
88
"ios": "react-native run-ios",
9-
"build:ios": "cd ios && xcodebuild -workspace SwiftChat.xcworkspace -scheme SwiftChat -sdk iphonesimulator -configuration Release -destination generic/platform=iOS CODE_SIGN_IDENTITY=\"\" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO clean archive | xcpretty",
9+
"build:ios": "cd ios && xcodebuild -workspace VifChat.xcworkspace -scheme SwiftChat -sdk iphonesimulator -configuration Release -destination generic/platform=iOS CODE_SIGN_IDENTITY=\"\" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO clean archive | xcpretty",
1010
"format": "npx prettier --check '*.{js,ts}'",
1111
"lint": "npx eslint .",
1212
"start": "react-native start",

server/install.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# curl ... | bash -s -- --region us-west-2
77
# ./install.sh # from cloned repo
88
# ./install.sh --region us-west-2
9-
# ./install.sh --region us-west-2 --stack MySwiftChat
9+
# ./install.sh --region us-west-2 --stack MyVifChat
1010
# ./install.sh --profile myprofile --region us-west-2
1111

1212
main() {
@@ -75,7 +75,7 @@ wait_stack() {
7575

7676
# ===== Parse args =====
7777
REGION=""
78-
STACK_NAME="SwiftChat"
78+
STACK_NAME="VifChat"
7979
REPO_NAME="swift-chat-api"
8080
TAG="latest"
8181
PROFILE=""

0 commit comments

Comments
 (0)