Skip to main content

Getting started

Requirements​

Setup is intended for Apple machines running OSX 15 (Sequoia) .

iOS setup uses Xcode 16 and iOS 18 as default.

Android setup uses Android Studio Ladybug | 2024.2.2 and Android 34 as default.

Setup​

Setup local machine for development

Run script to install tools and libraries (from packages/native folder)

sh scripts/setup_mac.sh

The script will install the main dependancies needed for the project. Follow next steps to setup iOS and Android tools.

Just for reference here's the environment set up for react-native cli.

iOS Setup​

The easiest way to install Xcode is via the Mac App Store. Installing Xcode will also install the iOS Simulator and all the necessary tools to build your iOS app. Download and install Xcode 15.4.

Setup the iOS tools and dependancies (from packages/native folder)

sh /scripts/configure_ios.sh

Follow instructions to run on iOS simulator

Troubleshooting iOS​

Consider cleaning the project in case of issues with pods or iOS dependancies

yarn workspace native clean

Clean iOS and node_modules folder.

Android Setup​

Download and install Android Studio. While on Android Studio installation wizard, make sure the boxes next to all of the following items are checked:

  • Android SDK
  • Android SDK Platform
  • Android Virtual Device

Setup the Android tools and dependancies Add the following lines to your ~/.zshrc

export ANDROID_HOME=$HOME/Library/Android/sdk
export PATH=$PATH:$ANDROID_HOME/emulator
export PATH=$PATH:$ANDROID_HOME/platform-tools

Then

source ~/.zshrc

Follow instructions to run on Android emulator

Troubleshooting Android​

Consider cleaning the project in case of issues with pods or iOS dependancies,

yarn clean

Clean Android and node_modules folder.