Merge pull request #117 from intercom/uv/add_setup_script

New setup script + updated readme

Author: uddish

example/README.md

@@ -4,42 +4,46 @@
 
 To get started with the @intercom/intercom-react-native example app, please follow the instructions below:
 
-1. Generate a new .env file by running the following command in your terminal:
-```sh
-sh scripts/generateEnv.sh
-```
-
-This command will create a .env file inside the example directory.
+1. Install XCode before you setup the app.
+>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.
 
-1. Fill in the required Android and iOS API keys and workspace IDs in the .env file. Other variables are optional.
 
-2. Install the dependencies by running the following command in the project directory:
+2. Setup the app using:
+```sh
+./script/setup
+```
+This command will install all the dependencies required to run the example app.
 
+3. Generate a new .env file by running the following command in your terminal:
 ```sh
-yarn
+sh scripts/generateEnv.sh
 ```
+This command will create a .env file <b>inside the example directory</b>.
+Fill in the required App ID in the .env file. Other variables are optional.
 
-### Android
 
-To run the app on Android, execute the following command:
 
+## Running the app
+
+To run the app on Android, execute the following command:
 
 ```sh
 yarn example android --variant=fossDebug
 ```
 
-### iOS
-For iOS, you need to install the necessary pods. Go to the example/ios directory in your terminal and run:
+To run the app on Android, execute the following command:
 
 ```sh
-pod install
+yarn example ios
 ```
 
-Once the pods are installed, go back to the project's root directory and execute the following command to run the app on iOS:
+## Troubleshooting
 
+1. If you are facing issues related to pods, you can install them separately using:
 ```sh
-yarn example ios
+pod install
 ```
 
-### Notes:
-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.
+2. For issues related to android, try opening and running the example app from the android studio.
+
+3. For general iOS build errors, opening and running the example app from XCode also helps.

script/setup

@@ -0,0 +1,88 @@
+#!/bin/sh
+
+#
+# Functions
+#
+function log() {
+  echo "\n"
+  echo "======================================="
+  echo "$1"
+  echo "======================================="
+}
+
+
+
+EXPECTED_RUBY_VERSION=$(cat ${SOURCE_ROOT_DIR}/.ruby-version)
+ruby_version="2.4.4"
+rbenv_version="2.5.7"
+
+log "🏎️  Running React native setup script 🏎️"
+
+log "📱 Installing xcode tools 📱"
+
+if [ ! -f /Library/Developer/CommandLineTools/usr/lib/libxcrun.dylib ]; then
+  echo "⚠️ Xcode CommandLineTools not found installing. Please install and rerun this script ⚠️"
+  xcode-select --install
+  exit 1
+fi
+echo "Xcode CommandLineTools installed 👍"
+
+if ! [ -x "$(command -v xcode-select)" ]; then
+  echo "⚠️ You need Xcode to setuo this project. Please install and rerun this script ⚠️"
+  exit 1s
+fi
+
+log "👀 Looking for Homebrew 👀"
+if ! [ -x "$(command -v brew)" ]; then
+  echo "🍺 Installing Homebrew 🍺"
+  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+  echo 'export PATH=/opt/homebrew/bin:$PATH' >> ~/.bash_profile
+  echo 'export PATH=/opt/homebrew/bin:$PATH' >> ~/.zshrc
+else
+  echo "Homebrew already installed 👍"
+fi
+
+log "👀 Looking for rbenv 👀"
+
+if ! [ -x "$(command -v rbenv)" ]; then
+  echo "🍺 Installing rbenv with brew 🍺"
+  brew install rbenv
+  echo 'eval "$(rbenv init -)"' >> ~/.bash_profile
+  echo 'eval "$(rbenv init -)"' >> ~/.zshrc
+  eval "$(rbenv init -)"
+  rbenv install "2.5.7"
+else
+  rbenv install "2.5.7"
+  echo "rbenv already installed 👍"
+fi
+rbenv local "2.5.7"
+
+log "👀 Looking for yarn 👀"
+if ! [ -x "$(command -v yarn)" ]; then
+  echo "🍺 Installing yarn 🍺"
+  brew install yarn
+else
+  echo "yarn already installed 👍"
+fi
+
+log "👀 Looking for ruby 👀"
+ruby-build --definitions | grep ^${EXPECTED_RUBY_VERSION} > /dev/null
+RUBYBUILD_DEFS_EXIT_CODE=$?
+if [ "$RUBYBUILD_DEFS_EXIT_CODE" -ne 0 ]; then
+    echo "🍺 Ruby Build: Cannot find Ruby version required, updating via brew 🍺"
+    brew update && brew upgrade ruby-build
+fi
+rbenv install --skip-existing
+echo "Ruby installed 👍"
+
+log "📟 installing dependencies 📟"
+yarn
+
+log "📟 installing dependencies for our example app 📟"
+cd example/ios
+pod install
+cd -
+
+echo "You're all set up 👍"
+echo "📱 Run example app on iOS using -> yarn example ios"
+echo "📱 Run example app on android using -> yarn example android --variant=fossDebug"