@@ -24,10 +24,11 @@ macOS platforms.
24
24
25
25
![ ] ( /assets/architecture.png )
26
26
27
- By default, we use AWS App Runner, which is commonly used to host Python FastAPI servers, offering high performance,
27
+ By default, we use ** AWS App Runner** , which is commonly used to host Python FastAPI servers, offering high performance,
28
28
scalability and low latency.
29
29
30
- Alternatively, we provide the option to replace App Runner with AWS Lambda using Function URL for a more cost-effective
30
+ Alternatively, we provide the option to replace App Runner with ** AWS Lambda** using Function URL for a more
31
+ cost-effective
31
32
solution, as shown in
32
33
this [ example] ( https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming ) .
33
34
@@ -46,25 +47,28 @@ enable your models.
46
47
47
48
### Step 1: Set up your API Key
48
49
49
- 1 . Right-click [ Parameter Store ] ( https://console.aws.amazon.com/systems-manager/parameters/ ) to open your AWS Console in
50
- new window .
50
+ 1 . Sign in to your AWS console and
51
+ right-click [ Parameter Store ] ( https://console.aws.amazon.com/systems-manager/parameters/ ) to open it in a new tab .
51
52
2 . Check whether you are in the [ supported region] ( #supported-region ) , then click on the ** Create parameter** button.
52
- 3 . Fill the parameters below, leaving other options as default.
53
- * ** Name** : Enter a name for your parameter (e.g., "SwiftChatAPIKey", this is ` ApiKeyParam ` you will fill
54
- in [ Step2] ( #step-2-deploy-stack-and-get-your-api-url ) ).
55
- * ** Type** : Select ` SecureString ` .
56
- * ** Value** : Any string without spaces (This is the ` API Key ` you'll need to configure your App
57
- in [ Step 3] ( #step-3-download-the-app-and-setup-with-api-url-and-api-key ) ).
53
+ 3 . Fill in the parameters below, leaving other options as default:
54
+
55
+ * ** Name** : Enter a parameter name (e.g., "SwiftChatAPIKey", will be used as ` ApiKeyParam ` in Step 2).
56
+
57
+ * ** Type** : Select ` SecureString `
58
+
59
+ * ** Value** : Enter any string without spaces.(this will be your ` API Key ` in Step 3)
60
+
58
61
4 . Click ** Create parameter** .
59
62
60
63
### Step 2: Deploy stack and get your API URL
61
64
62
- 1 . Click the following button to launch the CloudFormation Stack in the same region with your API Key just created.
63
- - App Runner
65
+ 1 . Click one of the following buttons to launch the CloudFormation Stack in the same region where your API Key was
66
+ created.
67
+ - ** App Runner**
64
68
65
69
[ ![ Launch Stack] ( assets/launch-stack.png )] ( https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatAPI&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatAppRunner.template )
66
70
67
- - Lambda (Note: Make sure your AWS account allows public Lambda Function URL )
71
+ - ** Lambda** (Note: For AWS customer use only )
68
72
69
73
[ ![ Launch Stack] ( assets/launch-stack.png )] ( https://console.aws.amazon.com/cloudformation/home#/stacks/create/template?stackName=SwiftChatLambda&templateURL=https://aws-gcr-solutions.s3.amazonaws.com/swift-chat/latest/SwiftChatLambda.template )
70
74
@@ -124,7 +128,7 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
124
128
125
129
### Image Features
126
130
127
- - [x] Support image generation with Chinese prompts
131
+ - [x] Support image generation with Chinese prompts(Make sure ` Claude 3 Haiku ` is enabled in your selected region)
128
132
- [x] View and zoom generated images
129
133
- [x] Long press images to save or share
130
134
- [x] Automatic image compression to optimize token usage
@@ -173,7 +177,7 @@ Congratulations 🎉 Your SwiftChat App is ready to use!
173
177
- No data collection
174
178
- Privacy-first approach
175
179
176
- ## App Build and development
180
+ ## App Build and Development
177
181
178
182
First, clone this repository. All app code is located in the ` react-native ` folder. Before proceeding, execute the
179
183
following command to download dependencies.
0 commit comments