Skip to content

Commit

Permalink
Merge pull request #8 from sendbird/feature/jerry/add-readme-sample
Browse files Browse the repository at this point in the history
Added README for SwiftUI sample
  • Loading branch information
jerry-jeon authored Sep 24, 2024
2 parents aef63b0 + 5cfb40f commit 824383b
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions Sample/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Sendbird Chat SwiftUI Sample
Sendbird Chat SwiftUI is a development kit with a declarative user interface, enabling easy and fast integration of standard chat features into new or existing client apps. This repository contains a sample app demonstrating the use of Sendbird Chat SwiftUI.
Learn more about Sendbird Chat SwiftUI in the [documentation](https://sendbird.com/docs/chat/uikit/v3/swiftui/overview). For assistance or questions, visit [our community](https://community.sendbird.com).

## Screenshots
![Screenshot](screenshots/screenshots.png)

## How to Use the Sample App

### 1. Clone the Repository

```bash
git clone [email protected]:sendbird/sendbird-swiftui-ios.git
```

### 2. Open in Xcode

Navigate to the sendbird-swiftui-ios/Sample directory and open it in Xcode. Make sure to open the sendbird-swiftui-ios/Sample/Sample.xcodeproj file.

### 3. Run the Sample App
Run the sample app on your simulator or device.

![Sample Screenshot](screenshots/run_sample.png)

### 4. Test with Your Data
<img src="screenshots/sample_screenshot.png" alt="Sample Screenshot" width="300">

For user ID and nickname, you can enter any values you like. The app will run in guest mode.

> Note: Avoid using guest mode in production.
## Customize with Your Data

To tailor the sample app to your needs, replace the default app ID with your own. You can obtain this by [creating a Sendbird application from the dashboard](https://dashboard.sendbird.com). You can also add your own data on the dashboard to test, allowing you to experience the app with data from your Sendbird application.
Binary file added Sample/screenshots/run_sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Sample/screenshots/sample_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Sample/screenshots/screenshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 824383b

Please sign in to comment.