Getting Started

Note: Make sure you have completed the React Native - Environment Setup instructions till "Creating a new application" step, before proceeding.

Step 1: Install Pods and Start the Metro Server

We need to install node_module dependencies and ios CocoaPods

# install node dependencies
npm i

# using yarn
yarn

# install pods with npx
npx pod-install

# or go to ./ios/
pod install

Then, you will need to start Metro, the JavaScript bundler that ships with React Native.

To start Metro, run the following command from the root of your React Native project:

# using npm
npm start

# OR using Yarn
yarn start

Step 2: Start your Application

Let Metro Bundler run in its own terminal. Open a new terminal from the root of your React Native project. Run the following command to start your Android or iOS app:

For Android (emulator or connected device)

To check if your computer detects Android device, type adb devices and you should see your phone and its ID

# using npm
npm run android

# OR using Yarn
yarn android

For iOS

Keep in mind you need to set a valid Developer team/account in Xcode before you can run the app

# using npm
npm run ios

# OR using Yarn
yarn ios

If everything is set up correctly, you should see your new app running in your Android Emulator or iOS Simulator shortly provided you have set up your emulator/simulator correctly.

This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.

Step 3: Run tests

Tests are run with jest and @testing-library for React Native

# install node dependencies
npm run test

#using yarn
yarn test

Troubleshooting

If you can't get this to work, see the Troubleshooting page.

Learn More

To learn more about React Native, take a look at the following resources:

React Native Website - learn more about React Native.
Getting Started - an overview of React Native and how setup your environment.
Learn the Basics - a guided tour of the React Native basics.
Blog - read the latest official React Native Blog posts.
@facebook/react-native - the Open Source; GitHub repository for React Native.

twaider / rn_flags