Skip to main content

Running the app

To build and run the app, you have two options.

Option 1: Download the apk file and start the react-native development server. (Recommended)​

Follow the steps below to run the app on your android device.

  1. Take a development build for you project from partner dashboard. Refer the doc here to know how to take an app build.
note

For iOS, you can follow the steps here to run the app on the simulator.

  1. Install the apk file on your device.

  1. Start the react-native development server by running the following command:

    yarn start

  2. Open development build on your device.

  3. Shake the device to open the developer menu and click on "Settings"

  4. Enter the IP address of the machine followed by the port number :8081 and click on "Ok".

  5. Go back to the app and click on "Reload" on developer menu. (Shake the device again to open the developer menu)

  6. You should now see the app running on your device.

  7. Any changes you make inside packages/<theme/extension> folder will be reflected in the app. (You can press r on the terminal or click on "Reload" on developer menu to manually reload the app)

Option 2: To build and run the app on an Android/iOS emulator​

Follow the steps below to run the app on your emulator.

  1. For android, take an android development build for you project from partner dashboard. Refer the doc here to know how to take an app build.

  2. Drag and drop the apk file on the emulator to install the app.

  3. Start the react-native development server by running the following command:

       yarn start

  4. Open your development app on the emulator.

note

For iOS, you can follow the steps here to run the app on the simulator.

Next steps​

Now that you have set up the starter app, you can start customizing it or create a custom plugin. To learn more about customizing the app theme, check out the Customizing app theme section.