Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/microsoft/react-native-test-app

react-native-test-app provides an app for all supported platforms as a package
https://github.com/microsoft/react-native-test-app

android ios macos react-native testing visionos windows

Last synced: 3 months ago
JSON representation

react-native-test-app provides an app for all supported platforms as a package

Lists

README

        

# React Native Test App

![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen)
[![Open in Visual Studio Code](https://img.shields.io/static/v1?logo=visualstudiocode&label=&message=Open%20in%20Visual%20Studio%20Code&color=007acc&labelColor=444444&logoColor=007acc)](https://vscode.dev/github/microsoft/react-native-test-app)
[![build](https://github.com/microsoft/react-native-test-app/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/microsoft/react-native-test-app/actions/workflows/build.yml)
[![npm version](https://img.shields.io/npm/v/react-native-test-app)](https://www.npmjs.com/package/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 ⚑](#quick-start-)
- [Migrate an Existing Test App πŸ“–](https://github.com/microsoft/react-native-test-app/wiki/Migrate-an-Existing-Test-App)
- [Configuring the Test App πŸ“–](https://github.com/microsoft/react-native-test-app/wiki/Manifest-%28app.json%29)
- [Upgrading the Test App πŸ“–](https://github.com/microsoft/react-native-test-app/wiki/Upgrading)
- [Learn More πŸ”](#learn-more-)
- [Libraries Using RNTA πŸ“š](#libraries-using-rnta-)
- [Known Issues ⚠️](#known-issues-️)
- [Contributing 🀝](#contributing-)
- [License πŸ“](#license-)

## Quick Start ⚑

_If you want to migrate an existing test app for a library, follow the
[dedicated guide in the wiki](https://github.com/microsoft/react-native-test-app/wiki/Migrate-an-Existing-Test-App)._

You can generate a new project using `npx`:

```sh
npx --package react-native-test-app@latest init
```

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

```sh
βœ” 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
β—‰ Windows
βœ” Where should we create the new project?? … sample
```

Install npm dependencies inside the new project folder:

**Yarn:**

```sh
cd sample
yarn
```

**npm:**

```sh
cd sample
npm install
```

Once the dependencies are installed, follow the
[platform specific instructions](https://github.com/microsoft/react-native-test-app/wiki/Quick-Start#platform-specific-instructions)
in 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"](https://youtu.be/DAEnPV78rQc)
by [@kelset](https://github.com/kelset) and
[@tido64](https://github.com/tido64) from React Native Europe 2021.
- ["Our Journey of Making React Native a Preferred Choice"](https://www.youtube.com/watch?v=PYMMxfttOug)
by [@kelset](https://github.com/kelset) and
[@tido64](https://github.com/tido64) from React Native Europe 2023.
- πŸ“– In the wiki, you can read more about
[the motivation](https://github.com/microsoft/react-native-test-app/wiki#motivation)
and
[the design](https://github.com/microsoft/react-native-test-app/wiki/Design)
of this tool.

## Libraries Using RNTA πŸ“š

- [microsoft/fluentui-react-native](https://github.com/microsoft/fluentui-react-native)
- [microsoft/rnx-kit](https://github.com/microsoft/rnx-kit)
- [shopify/restyle](https://github.com/Shopify/restyle)
- [react-native-add-calendar-event](https://github.com/vonovak/react-native-add-calendar-event)
- [react-native-apple-authentication](https://github.com/invertase/react-native-apple-authentication)
- [react-native-async-storage](https://github.com/react-native-async-storage/async-storage)

- [react-native-blur](https://github.com/Kureev/react-native-blur)
- [react-native-datetimepicker](https://github.com/react-native-datetimepicker/datetimepicker)
- [react-native-google-signin](https://github.com/react-native-google-signin/google-signin)
- [react-native-image-editor](https://github.com/callstack/react-native-image-editor)
- [react-native-netinfo](https://github.com/react-native-netinfo/react-native-netinfo)
- [react-native-masked-view](https://github.com/react-native-masked-view/masked-view)

- [react-native-menu](https://github.com/react-native-menu/menu)
- [react-native-segmented-control](https://github.com/react-native-segmented-control/segmented-control)
- [react-native-webview](https://github.com/react-native-webview/react-native-webview)
- [sparkfabrik-react-native-idfa-aaid](https://github.com/sparkfabrik/sparkfabrik-react-native-idfa-aaid)
- ...[and many more!](https://github.com/microsoft/react-native-test-app/network/dependents)

_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 the
[Troubleshooting wiki](https://github.com/microsoft/react-native-test-app/wiki/Troubleshooting).

## Contributing 🀝

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

Take a look at [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## License πŸ“

`react-native-test-app` is [MIT licensed](./LICENSE).