GitHub - microsoft/react-native-test-app: react-native-test-app provides an app for all supported platforms as a package (original) (raw)

React Native Test App

React Native Test App (RNTA) provides test apps for all platforms as a package. It handles the native bits for you so you can focus on what's important: your product.

• Quick Start ⚡
• Migrate an Existing Test App 📖
• Configuring the Test App 📖
• Upgrading the Test App 📖
• Learn More 🔍
• Libraries Using RNTA 📚
• Known Issues ⚠️
• Contributing 🤝
• License 📝

Quick Start ⚡

If you want to migrate an existing test app for a library, follow thededicated guide in the wiki.

You can generate a new project using npx:

npx --package react-native-test-app@ init

For example: npx --package react-native-test-app@4.2.3 init

You can always find the latest version here:https://github.com/microsoft/react-native-test-app/releases

Alternatively, if you're using a Bash-compatible shell:

npx --package react-native-test-app@$(npm view react-native-test-app version) init

Note

We don't recommend using @latest because npm may not always use the latest version. See npm/cli#5262 for more details.

In this example, we will create a project named "sample" in sample with apps for all platforms:

✔ What is the name of your test app? … sample
? Which platforms do you need test apps for? ›
Instructions:
    ↑/↓: Highlight option
    ←/→/[space]: Toggle selection
    a: Toggle all
    enter/return: Complete answer
◉   Android
◉   iOS
◉   macOS
◯   visionOS
◉   Windows
✔ Where should we create the new project? … sample

Install npm dependencies inside the new project folder:

Yarn:

cd sample yarn

npm:

cd sample npm install

Once the dependencies are installed, follow theplatform specific instructionsin the wiki.

Learn More 🔍

• 🗣️ If you want to learn how RNTA is used at Microsoft, check out the following talks:
  • "Improve all the repos – exploring Microsoft’s DevExp"by @kelset and@tido64 from React Native Europe 2021.
  • "Our Journey of Making React Native a Preferred Choice"by @kelset and@tido64 from React Native Europe 2023.
• 📖 In the wiki, you can read more aboutthe motivationandthe designof this tool.

Libraries Using RNTA 📚

microsoft/fluentui-react-native •microsoft/rnx-kit •BabylonReactNative •callstack/repack •lottie-react-native •react-native-add-calendar-event •react-native-apple-authentication •react-native-async-storage •react-native-blur •react-native-clipboard •react-native-datetimepicker •react-native-google-signin •react-native-image-editor •react-native-keychain •react-native-masked-view •react-native-menu •react-native-netinfo •react-native-pager-view •react-native-safe-area-context •react-native-segmented-control •react-native-video •react-native-webview •realm-js •shopify/restyle •sparkfabrik-react-native-idfa-aaid •and many more…

Are you using RNTA? Submit a PR to add it to the list!

Known Issues ⚠️

For a list of known issues and workarounds, please refer to theTroubleshooting wiki.

Contributing 🤝

Thank you for your interest in this project! We welcome all contributions and suggestions!

Take a look at CONTRIBUTING.md for details.

License 📝

react-native-test-app is MIT licensed.