React Native Test App

React Native Test App provides test apps for all platforms as a package. Bring your own JS bundle, and let us manage the native bits.

This is a work in progress. You can read and discuss the RFC at React Native: Discussions and Proposals.

For more details, please refer to the wiki.

Dependencies

react-native-test-app is published with source code only. You will still need to compile the test apps yourself.

• Android:
  • Android Studio 3.6 or later
    • Android SDK Platform 29
    • Android SDK Build-Tools 29.0.3
    • To install the required SDKs, go into Preferences ❭ Appearance & Behavior ❭ System Settings ❭ Android SDK.
• iOS/macOS:
  • Xcode 11.3 or later
  • CocoaPods
• Windows:
  • Ensure that Developer Mode is turned on in Windows Settings app
  • Install development dependencies as described in the React Native for Windows documentation
  • Google Chrome (optional, but recommended for JS debugging)

Quick Start

Install react-native-test-app as a dev dependency. We will use Plop to generate the test app:

yarn add react-native-test-app --dev
yarn plop --plopfile node_modules/react-native-test-app/plopfile.js --dest sample

--dest tells Plop where to generate the files. In this example, it will generate files under sample folder. Choose the appropriate place to store your test app, then answer a couple of questions:

? What is the name of your test app? Sample
? Which platforms do you need test apps for? all

Run yarn inside the new project folder:

cd sample
yarn

Once the dependencies are installed, follow the platform specific instructions below.

Android

# Bundle the JS first so Gradle can find
# the assets.
yarn build:android
yarn android

# Instead of `yarn android`, you can
# also build and run `sample/android` in
# Android Studio.

# On macOS, you can open the project from
# the terminal:
open -a "Android Studio" android

iOS

# Bundle the JS first so CocoaPods can
# find the assets.
yarn build:ios
pod install --project-directory=ios
yarn ios

# Instead of `yarn ios`, you can also
# build and run in Xcode.
open ios/Sample.xcworkspace

macOS

# Bundle the JS first so CocoaPods can
# find the assets.
yarn build:macos
pod install --project-directory=macos
yarn macos

# Instead of `yarn macos`, you can also
# build and run in Xcode.
open macos/Sample.xcworkspace

Windows

# Bundle the JS first so the assets can
# be included in the project.
yarn build:windows
yarn install-windows-test-app
yarn windows

# Instead of `yarn windows`, you can
# also build and run 'windows/Sample.sln'
# in Visual Studio.

# To run test app on your local machine,
# remember to set platform to x64 (it is
# set to ARM by default)

Developing React Native Test App

Additional dependencies:

• Node 12 LTS
• Yarn
• macOS: Homebrew

We'll be using the Example app for all development of the React Native Test App. Some platforms may require extra steps for the initial set up. Please follow the steps below, then jump to the appropriate section(s) for the final steps.

Open a terminal and navigate to your clone of this repository:

cd react-native-test-app

# This step only needs to be done once,
# before we can install the Example app's
# dependencies. It is stored in
# `~/.config/yarn/link/react-native-test-app`.
# You can run `unlink` if you need to
# remove it later.
yarn link

# Install Example app's dependencies.
cd example
yarn

# Now we use the link we created earlier.
# This step needs to be run _after_
# `yarn` otherwise it will be
# overwritten.
yarn link "react-native-test-app"

Android

# Bundle the JS first so Gradle can find
# the assets.
yarn build:android

# Finally, open the `android` folder in
# Android Studio.

# On macOS, you can open the project from
# the terminal:
open -a "Android Studio" android

iOS

# Bundle the JS first so CocoaPods can
# find the assets.
yarn build:ios
pod install --project-directory=ios

# Finally, open the Xcode workspace.
open ios/Example.xcworkspace

macOS

# Bundle the JS first so CocoaPods can
# find the assets.
yarn build:macos
pod install --project-directory=macos

# Finally, open the Xcode workspace.
open macos/Example.xcworkspace

Windows

# Bundle the JS first so the assets can
# be included in the project.
yarn build:windows
yarn install-windows-test-app

# Finally, open 'Example.sln' in Visual
# Studio.

# To run test app on your local machine,
# remember to set platform to x64 (it is
# set to ARM by default)

Known Issues

For a list of known issues and workarounds, please go to the Troubleshooting page in the wiki.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.