Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/aws-samples/swift-chat

A lightning-fast, cross-platform AI chat application built with React Native.
https://github.com/aws-samples/swift-chat

amazon-bedrock amazon-nova android aws bedrock-client chat claude-3-7-sonnet deepseek genai gpt-4o image-generation ios mac mobile-app ollama ollama-client react-native swift-chat swiftchat video-understanding

Last synced: 6 months ago
JSON representation

A lightning-fast, cross-platform AI chat application built with React Native.

Awesome Lists containing this project

README 

          
# SwiftChat - A Cross-platform AI Chat App



> πŸš€ Your Personal AI Assistant - Fast, Private, and Cross-platform



[![GitHub Release](https://img.shields.io/github/v/release/aws-samples/swift-chat)](https://github.com/aws-samples/swift-chat/releases)

[![License](https://img.shields.io/badge/license-MIT--0-green)](LICENSE)



## πŸ“± Quick Download



- [Download for Android](https://github.com/aws-samples/swift-chat/releases/download/2.2.0/SwiftChat.apk)

- [Download for macOS](https://github.com/aws-samples/swift-chat/releases/download/2.2.0/SwiftChat.dmg)

- For iOS: Currently available through local build with Xcode



[δΈ­ζ–‡](/README_CN.md)



SwiftChat is a fast and responsive AI chat application developed with [React Native](https://reactnative.dev/) and

powered by [Amazon Bedrock](https://aws.amazon.com/bedrock/), with compatibility extending to other model providers such

as Ollama, DeepSeek, OpenAI and OpenAI Compatible. With its minimalist design philosophy and robust privacy protection,

it delivers real-time streaming conversations and AI image generation capabilities across Android, iOS, and macOS

platforms.



![](assets/promo.avif)



### What's New πŸ”₯



- Support for OpenAI Compatible models. You can now

  use [easy-model-deployer](https://github.com/aws-samples/easy-model-deployer),

  OpenRouter, or any OpenAI-compatible model provider via SwiftChat. Please

  check [Configure OpenAI Compatible](#openai-compatible) section for more details(From v2.2.0).

- Support for quick model switching (From v2.2.0).

- Support regeneration of AI responses (From v2.2.0).



**Key Features:**



- Real-time streaming chat with AI

- Rich Markdown Support: Tables, Code Blocks, LaTeX and More

- AI image generation with progress

- Multimodal support (images, videos & documents)

- Conversation history list view and management

- Cross-platform support (Android, iOS, macOS)

- Tablet-optimized for iPad and Android tablets

- Fast launch and responsive performance

- Multiple AI model

  supported ([Amazon Bedrock](https://aws.amazon.com/bedrock/), [Ollama](https://github.com/ollama/ollama), [DeepSeek](https://www.deepseek.com/), [OpenAI](https://openai.com/)

  and [OpenAI Compatible](#openai-compatible) Models)

- Fully Customizable System Prompt Assistant



**Supported Features For Amazon Nova series**



- Record 30-second videos directly on Android and iOS for Nova analysis

- Upload large videos (1080p/4K) beyond 8MB with auto compression

- Support using natural language to make Nova Canvas generate images, remove backgrounds, replace backgrounds, and

  create images in similar styles.



### Feature Showcase



#### YouTube Video



[](https://www.youtube.com/watch?v=rey05WzfEbM)

> The content in the video is an early version. For UI, architecture, and inconsistencies, please refer to the current 

> documentation.



**Comprehensive Multimodal Analysis**: Text, Image, Document and Video
















**Creative Image Suite**: Generation, Style Replication, Background Removal & Replacement with Nova Canvas
















**System Prompt Assistant**: Useful Preset System Prompts with Full Management Capabilities (Add/Edit/Sort/Delete)



![](assets/animations/english_teacher.avif)



**Rich Markdown Support**: Paragraph, Code Blocks, Tables, LaTeX and More



![](assets/markdown.avif)



We redesigned the UI with optimized font sizes and line spacing for a more elegant and clean presentation.

All of these features are also seamlessly displayed on Android and macOS with native UI



> Note: Some animated images have been sped up for demonstration. If you experience lag, please view on Chrome, Firefox,

> or Edge browser on your computer.



## Architecture



![](/assets/architecture.avif)



By default, we use **AWS App Runner**, which is commonly used to host Python FastAPI servers, offering high performance,

scalability and low latency.



Alternatively, we provide the option to replace App Runner with **AWS Lambda** using Function URL for a more

cost-effective

solution, as shown in

this [example](https://github.com/awslabs/aws-lambda-web-adapter/tree/main/examples/fastapi-response-streaming).



## Getting Started with Amazon Bedrock



### Prerequisites



Ensure you have access to Amazon Bedrock foundation models. SwiftChat default settings are:



- Region: `us-west-2`

- Text Model: `Amazon Nova Pro`

- Image Model: `Stable Diffusion 3.5 Large`



If you are using the image generation feature, please make sure you have enabled access to the `Amazon Nova Lite` model.

Please follow

the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access-modify.html) to

enable your models.



πŸ”§ Configuration Steps (Click to expand)



### Step 1: Set up your API Key



1. Sign in to your AWS console and

   right-click [Parameter Store](https://console.aws.amazon.com/systems-manager/parameters/) to open it in a new tab.

2. Check whether you are in the [supported region](#supported-region), then click on the **Create parameter** button.

3. Fill in the parameters below, leaving other options as default:



    - **Name**: Enter a parameter name (e.g., "SwiftChatAPIKey", will be used as `ApiKeyParam` in Step 2).



    - **Type**: Select `SecureString`



    - **Value**: Enter any string without spaces.(this will be your `API Key` in Step 3)



4. Click **Create parameter**.



### Step 2: Deploy stack and get your API URL



1. Click one of the following buttons to launch the CloudFormation Stack in the same region where your API Key was

   created.



    - **App Runner**



      [![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)



    - **Lambda** (Note: For AWS customer use only)



      [![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)



2. Click **Next**, On the "Specify stack details" page, provide the following information:

    - Fill the `ApiKeyParam` with the parameter name you used for storing the API key (e.g., "SwiftChatAPIKey").

    - For App Runner, choose an `InstanceTypeParam` based on your needs.

3. Click **Next**, Keep the "Configure stack options" page as default, Read the Capabilities and Check the "I

   acknowledge that AWS CloudFormation might create IAM resources" checkbox at the bottom.

4. Click **Next**, In the "Review and create" Review your configuration and click **Submit**.



Wait about 3-5 minutes for the deployment to finish, then click the CloudFormation stack and go to **Outputs** tab, you

can find the **API URL** which looks like: `https://xxx.xxx.awsapprunner.com` or `https://xxx.lambda-url.xxx.on.aws`



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



1. Launch the App, open the drawer menu, and tap **Settings**.

2. Paste the `API URL` and `API Key`(The **Value** you typed in Parameter Store) then select the Region.

3. Click the top right βœ“ icon to save your configuration and start your chat.



Congratulations πŸŽ‰ Your SwiftChat App is ready to use!



### Supported Region



- US East (N. Virginia): us-east-1

- US West (Oregon): us-west-2

- Asia Pacific (Mumbai): ap-south-1

- Asia Pacific (Singapore): ap-southeast-1

- Asia Pacific (Sydney): ap-southeast-2

- Asia Pacific (Tokyo): ap-northeast-1

- Canada (Central): ca-central-1

- Europe (Frankfurt): eu-central-1

- Europe (London): eu-west-2

- Europe (Paris): eu-west-3

- South America (SΓ£o Paulo): sa-east-1



## Getting Started with Other Model Providers



### Ollama



πŸ”§ Configure Ollama (Click to expand)



1. Navigate to the **Settings Page** and select the **Ollama** tab.

2. Enter your Ollama Server URL. For example:

    ```bash

    http://localhost:11434

    ```

3. Once the correct Server URL is entered, you can select your desired Ollama models from the **Text Model** dropdown

   list.



### DeepSeek



πŸ”§ Configure DeepSeek (Click to expand)



1. Go to the **Settings Page** and select the **DeepSeek** tab.

2. Input your DeepSeek API Key.

3. Choose DeepSeek models from the **Text Model** dropdown list. Currently, the following DeepSeek models are supported:

    - `DeepSeek-V3`

    - `DeepSeek-R1`



### OpenAI



πŸ”§ Configure OpenAI (Click to expand)



1. Navigate to the **Settings Page** and select the **OpenAI** tab.

2. Enter your OpenAI API Key.

3. Select OpenAI models from the **Text Model** dropdown list. The following OpenAI models are currently supported:

    - `GPT-4o`

    - `GPT-4o mini`



Additionally, if you have deployed the [ClickStream Server](#step-2-deploy-stack-and-get-your-api-url), you can enable

the **Use Proxy** option to forward your requests.



### OpenAI Compatible



πŸ”§ Configure OpenAI Compatible models (Click to expand)



1. Navigate to the **Settings Page** and select the **OpenAI** tab.

2. Under **OpenAI Compatible**, enter the following information:

    - `Base URL` of your model provider

    - `API Key` of your model provider

    - `Model ID` of the models you want to use (separate multiple models with commas)

3. Select one of your models from the **Text Model** dropdown list.



## Detailed Features



**Quick Access Tools**: Code & Content Copy, Selection Mode, Model Switch, Regenerate, Scroll Controls and Token Counter














We feature streamlined chat History, Settings pages, and intuitive Usage statistics:



![](assets/history_settings.avif)



### Message Handling



- [x] Text copy support:

    - Copy button at the bottom of messages, or directly click the model name or user title section.

    - Copy button in code blocks

    - Direct Select and copy code on macOS (double click or long click on iOS)

    - Long press text to copy entire sentence (Right-click on macOS)

- [x] Text selection mode by click selection button.

- [x] Message timeline view in history

- [x] Delete messages through long press in history

- [x] Click to preview for documents videos and images



### Image Features



- [x] Support image generation with Chinese prompts(Make sure `Amazon Nova Lite` is enabled in your selected region)

- [x] Long press images to save or share

- [x] Automatic image compression to improve response speed



### User Experience



- [x] Haptic feedback for Android and iOS (can be disabled in Settings)

- [x] Support landscape mode on Android/iOS devices

- [x] Double tap title bar to scroll to top

- [x] Click bottom arrow to view latest messages

- [x] Display system prompt and model switch icon again by clicking on the chat title

- [x] View current session token usage by tapping twice Chat title

- [x] Check detailed token usage and image generation count in Settings

- [x] In-app upgrade notifications (Android & macOS)



We have optimized the layout for landscape mode. As shown below, you can comfortably view table/code contents in

landscape orientation.



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



## What Makes SwiftChat Really "Swift"?



πŸš€ **Fast Launch Speed**



- Thanks to the **AOT** (Ahead of Time) compilation of RN Hermes engine

- Added **lazy loading** of complex components

- App launches instantly and is immediately ready for input



🌐 **Fast Request Speed**



- Speed up end-to-end API requests through **image compression**

- Deploying APIs in the **same region** as Bedrock provides lower latency



πŸ“± **Fast Render Speed**



- Using `useMemo` and custom caching to creates secondary cache for session content

- Reduce unnecessary re-renders and speed up streaming messages display

- All UI components are rendered as **native components**



πŸ“¦ **Fast Storage Speed**



- By using **react-native-mmkv** Messages can be read, stored, and updated **10x faster** than AsyncStorage

- Optimized session content and session list storage structure to accelerates history list display



## App Privacy & Security



- Encrypted API key storage

- Minimal permission requirements

- Local-only data storage

- No user behavior tracking

- No data collection

- Privacy-first approach



## App Build and Development



First, clone this repository. All app code is located in the `react-native` folder. Before proceeding, execute the

following command to download dependencies.



```bash

cd react-native && npm i && npm start

```



### Build for Android



open a new terminal and execute:



```bash

npm run android

```



### Build for iOS



also open a new terminal, for the first time you need to install the native dependencies

by execute `cd ios && pod install && cd ..`, then execute the follow command:



```bash

npm run ios

```



### Build for macOS



1. Execute `npm start`.

2. Double click `ios/SwiftChat.xcworkspace` to open the project in your Xcode.

3. Change the build destination to `My Mac (Mac Catalyst)` then click the β–Ά Run button.



## API Reference



Please refer [API Reference](server/README.md)



## How to upgrade?



### Upgrade App



- **Android** and **macOS**: Navigate to **Settings** Page, if there is a new version, you will find it at the bottom

  of this page, then click the app version to download and install it.

- **iOS**: If a new version is released in the [Release page](https://github.com/aws-samples/swift-chat/releases),

  update your local code, rebuild and install your app by Xcode.



**Note**: After downloading a new version, please check

the [release notes](https://github.com/aws-samples/swift-chat/releases) to see if an API version update is required.



### Upgrade API



- **For AppRunner**: Click and open [App Runner Services](https://console.aws.amazon.com/apprunner/home#/services) page,

  find and open `swiftchat-api`, click top right **Deploy** button.

- **For Lambda**: Click and open [Lambda Services](https://console.aws.amazon.com/lambda/home#/functions), find and open

  your Lambda which start with `SwiftChatLambda-xxx`, click the **Deploy new image** button and click Save.



## Security



See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.



## License



This library is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file.