Skip to content

Commit 824383b

Browse files
authored
Merge pull request #8 from sendbird/feature/jerry/add-readme-sample
Added README for SwiftUI sample
2 parents aef63b0 + 5cfb40f commit 824383b

File tree

4 files changed

+34
-0
lines changed

4 files changed

+34
-0
lines changed

Sample/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Sendbird Chat SwiftUI Sample
2+
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.
3+
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).
4+
5+
## Screenshots
6+
![Screenshot](screenshots/screenshots.png)
7+
8+
## How to Use the Sample App
9+
10+
### 1. Clone the Repository
11+
12+
```bash
13+
git clone [email protected]:sendbird/sendbird-swiftui-ios.git
14+
```
15+
16+
### 2. Open in Xcode
17+
18+
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.
19+
20+
### 3. Run the Sample App
21+
Run the sample app on your simulator or device.
22+
23+
![Sample Screenshot](screenshots/run_sample.png)
24+
25+
### 4. Test with Your Data
26+
<img src="screenshots/sample_screenshot.png" alt="Sample Screenshot" width="300">
27+
28+
For user ID and nickname, you can enter any values you like. The app will run in guest mode.
29+
30+
> Note: Avoid using guest mode in production.
31+
32+
## Customize with Your Data
33+
34+
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.

Sample/screenshots/run_sample.png

51.4 KB
Loading
144 KB
Loading

Sample/screenshots/screenshots.png

504 KB
Loading

0 commit comments

Comments
 (0)