Skip to content

Commit eccc097

Browse files
committed
add example readme
1 parent 7b6ed24 commit eccc097

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

example/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Welcome to @intercom/intercom-react-native example app 👋
2+
3+
## Installation
4+
5+
To get started with the @intercom/intercom-react-native example app, please follow the instructions below:
6+
7+
1. Generate a new .env file by running the following command in your terminal:
8+
```sh
9+
sh scripts/generateEnv.sh
10+
```
11+
12+
This command will create a .env file inside the example directory.
13+
14+
1. Fill in the required Android and iOS API keys and workspace IDs in the .env file. Other variables are optional.
15+
16+
2. Install the dependencies by running the following command in the project directory:
17+
18+
```sh
19+
yarn
20+
```
21+
22+
### Android
23+
24+
To run the app on Android, execute the following command:
25+
26+
27+
```sh
28+
yarn example android --variant=fossDebug
29+
```
30+
31+
### iOS
32+
For iOS, you need to install the necessary pods. Go to the example/ios directory in your terminal and run:
33+
34+
```sh
35+
cd example/ios
36+
pod install
37+
```
38+
39+
Once the pods are installed, go back to the project's root directory and execute the following command to run the app on iOS:
40+
41+
```sh
42+
yarn example ios
43+
```
44+
45+
### Notes:
46+
Please note that there is a known bug that prevents the iOS app from building on the latest Xcode. Therefore, it's recommended to use Xcode 14.2.

0 commit comments

Comments
 (0)