microsoft
/
react-native-macos
зеркало из https://github.com/microsoft/react-native-macos.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
react-native-macos/RNTester/README.md

80 строки
3.0 KiB
Markdown
Исходник Обычный вид История

Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 06:50:47 +03:00
# RNTester
Add docs for examples
2015-10-12 18:16:39 +03:00
Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 06:50:47 +03:00
The RNTester showcases React Native views and modules.
Add docs for examples
2015-10-12 18:16:39 +03:00
## Running this app
Before running the app, make sure you ran:
Add git clone step to READMEs
2015-11-17 06:55:45 +03:00
git clone https://github.com/facebook/react-native.git
Add docs for examples
2015-10-12 18:16:39 +03:00
cd react-native
npm install
### Running on iOS
Add SUPPORT document, update other GitHub templates (#23778) Summary: See https://help.github.com/en/articles/adding-support-resources-to-your-project. The SUPPORT file is surfaced by GitHub in several useful places. The goal is to increase discoverability of all support resources, giving the reader an opportunity to find the help they need before they open an issue in the repository. A secondary goal is to use a friendlier tone when communicating our processes. The issue templates have been standardized to follow the format used by GitHub's template tool. A bug in the "Regressions" template, due to its use of multiple labels, is fixed as well. The bot will explain how a changelog can be fixed when it nags a PR. [General][Added] - Added SUPPORT resources, friendlier messaging. Pull Request resolved: https://github.com/facebook/react-native/pull/23778 Differential Revision: D14333911 Pulled By: hramos fbshipit-source-id: d4b3e75194ea7d5c932dd8df2393d5b189f30f35
2019-03-06 04:03:04 +03:00
Both macOS and Xcode are required.
Add docs for examples
2015-10-12 18:16:39 +03:00
Use CocoaPods-based RNTesterPods for iOS tests (#25416) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/25416 Use CocoaPods-based RNTesterPods workspace to run iOS unit tests and integration tests. This is necessary as new iOS projects now use CocoaPods by default. CocoaPods also powers the new package auto-linking feature. In order to provide test coverage for this new default configuration, our iOS tests are being migrated to use a CocoaPods-managed RNTester workspace. This applies to both Circle CI, and Sandcastle. Changelog: [iOS] [Changed] - Use RNTesterPods for iOS Tests Reviewed By: fkgozali Differential Revision: D16052466 fbshipit-source-id: 724b0c51008882d3c06a9074693fe23e74abe86b
2019-06-29 05:12:42 +03:00
- Install CocoaPods. We installing CocoaPods using [Homebrew](http://brew.sh/): `brew install cocoapods`
iOS OSS: added CocoaPods setup to RNTester and fix up the podspecs Summary: This adds a way to test out CocoaPods build to RNTester, but as a separate project/workspace. This also fixes the podspecs due to Fabric stuffs. Note that this setup is meant to be run manually, not by CI (yet) Reviewed By: mmmulani Differential Revision: D7603823 fbshipit-source-id: 2219aa4c77f40ec07097a5c9ed4052529226618b
2018-04-13 01:54:36 +03:00
- Run `cd RNTester; pod install`
Use CocoaPods-based RNTesterPods for iOS tests (#25416) Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/25416 Use CocoaPods-based RNTesterPods workspace to run iOS unit tests and integration tests. This is necessary as new iOS projects now use CocoaPods by default. CocoaPods also powers the new package auto-linking feature. In order to provide test coverage for this new default configuration, our iOS tests are being migrated to use a CocoaPods-managed RNTester workspace. This applies to both Circle CI, and Sandcastle. Changelog: [iOS] [Changed] - Use RNTesterPods for iOS Tests Reviewed By: fkgozali Differential Revision: D16052466 fbshipit-source-id: 724b0c51008882d3c06a9074693fe23e74abe86b
2019-06-29 05:12:42 +03:00
- Open the generated `RNTesterPods.xcworkspace`. This is not checked in, as it is generated by CocoaPods. Do not open `RNTesterPods.xcodeproj` directly.
iOS OSS: added CocoaPods setup to RNTester and fix up the podspecs Summary: This adds a way to test out CocoaPods build to RNTester, but as a separate project/workspace. This also fixes the podspecs due to Fabric stuffs. Note that this setup is meant to be run manually, not by CI (yet) Reviewed By: mmmulani Differential Revision: D7603823 fbshipit-source-id: 2219aa4c77f40ec07097a5c9ed4052529226618b
2018-04-13 01:54:36 +03:00
Add docs for examples
2015-10-12 18:16:39 +03:00
### Running on Android
You'll need to have all the [prerequisites](https://github.com/facebook/react-native/tree/master/ReactAndroid#prerequisites) (SDK, NDK) for Building React Native installed.
Documentation Fix for the way to run RNTester Android Summary: `installDebug` is no longer working, `installJscDebug` is the right command. ALso removed Genymotion recommendation. Reviewed By: mdvacca Differential Revision: D13912729 fbshipit-source-id: 1ed5eccc8460c48ee417efbd360f42783010d376
2019-09-04 02:17:48 +03:00
Start an Android emulator.
Add docs for examples
2015-10-12 18:16:39 +03:00
cd react-native
Documentation Fix for the way to run RNTester Android Summary: `installDebug` is no longer working, `installJscDebug` is the right command. ALso removed Genymotion recommendation. Reviewed By: mdvacca Differential Revision: D13912729 fbshipit-source-id: 1ed5eccc8460c48ee417efbd360f42783010d376
2019-09-04 02:17:48 +03:00
./gradlew :RNTester:android:app:installJscDebug
Move packager launcher scripts outside of `packager/` Summary: in order to prepare open sourcing React Native Packager, we have to move scripts specific to React Native to a directory that will continue to exist. Reviewed By: javache Differential Revision: D5112193 fbshipit-source-id: eac77d0d981aecef7ee52365a6856340420a5638
2017-05-24 02:05:52 +03:00
./scripts/packager.sh
Add docs for examples
2015-10-12 18:16:39 +03:00
_Note: Building for the first time can take a while._
Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 06:50:47 +03:00
Open the RNTester app in your emulator.
nit: Fix RNTester gradle command (#26140) Summary: The README.md was slightly out of date. ## Changelog [Android] [Fixed] - Fixed RNTester instructions Pull Request resolved: https://github.com/facebook/react-native/pull/26140 Test Plan: Ran `./gradlew :RNTester:android:app:installJscDebug` to build and install RNTester on my device. Differential Revision: D17178074 Pulled By: mdvacca fbshipit-source-id: 677f91833170af54eeb1f0b5431dd94eae7668ac
2019-09-05 00:39:42 +03:00
If you want to use a physical device, run `adb devices`, then `adb -s <device name> reverse tcp:8081 tcp:8081`.
See [Running on Device](https://facebook.github.io/react-native/docs/running-on-device.html) for additional instructions on using a physical device.
Add docs for examples
2015-10-12 18:16:39 +03:00
Allow building UIExplorer with Buck Summary:This adds a BUCK file to UIExplorer to allow building it with buck. It is based on the one in the movies app but I removed the extra deps that were not needed in both files. Also add build version number and target sdk version in the Android manifest so Buck can use it since it was only specified in the gradle build and caused the app to run on a super old target sdk. bestander mkonicek Would it be simple to also build the ndk part with Buck? Right now it is built with gradle and packaged after. I suppose it is already being done internally at facebook. The BUCK files for building the cpp code are already there but I couldn't figure out what was missing to make it work :( That is pretty much the only missing part to have first class support for building RN apps with Buck in OSS. We could eventually include BUCK files with the generated project. **Test plan (required)** Build and run UIExplorer and Movies examples using Buck. Edited: ``` ./gradlew ReactAndroid:packageReactNdkLibsForBuck Closes https://github.com/facebook/react-native/pull/6399 Reviewed By: mkonicek Differential Revision: D3042355 Pulled By: bestander fb-gh-sync-id: 74760c7ba12d35b1853d2e3706c2ba130f9eef1c fbshipit-source-id: 74760c7ba12d35b1853d2e3706c2ba130f9eef1c
2016-04-12 23:03:54 +03:00
### Running with Buck
Follow the same setup as running with gradle.
Install Buck from [here](https://buckbuild.com/setup/install.html).
Run the following commands from the react-native folder:
./gradlew :ReactAndroid:packageReactNdkLibsForBuck
Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 06:50:47 +03:00
buck fetch rntester
buck install -r rntester
Move packager launcher scripts outside of `packager/` Summary: in order to prepare open sourcing React Native Packager, we have to move scripts specific to React Native to a directory that will continue to exist. Reviewed By: javache Differential Revision: D5112193 fbshipit-source-id: eac77d0d981aecef7ee52365a6856340420a5638
2017-05-24 02:05:52 +03:00
./scripts/packager.sh
Allow building UIExplorer with Buck Summary:This adds a BUCK file to UIExplorer to allow building it with buck. It is based on the one in the movies app but I removed the extra deps that were not needed in both files. Also add build version number and target sdk version in the Android manifest so Buck can use it since it was only specified in the gradle build and caused the app to run on a super old target sdk. bestander mkonicek Would it be simple to also build the ndk part with Buck? Right now it is built with gradle and packaged after. I suppose it is already being done internally at facebook. The BUCK files for building the cpp code are already there but I couldn't figure out what was missing to make it work :( That is pretty much the only missing part to have first class support for building RN apps with Buck in OSS. We could eventually include BUCK files with the generated project. **Test plan (required)** Build and run UIExplorer and Movies examples using Buck. Edited: ``` ./gradlew ReactAndroid:packageReactNdkLibsForBuck Closes https://github.com/facebook/react-native/pull/6399 Reviewed By: mkonicek Differential Revision: D3042355 Pulled By: bestander fb-gh-sync-id: 74760c7ba12d35b1853d2e3706c2ba130f9eef1c fbshipit-source-id: 74760c7ba12d35b1853d2e3706c2ba130f9eef1c
2016-04-12 23:03:54 +03:00
_Note: The native libs are still built using gradle. Full build with buck is coming soon(tm)._
Detox debug build (#22572) Summary: Adds a Detox configuration and instructions for running the app in development mode in Detox. This speeds up developing tests, because changes to production code don't require a full rebuild. Pull Request resolved: https://github.com/facebook/react-native/pull/22572 Differential Revision: D13396883 Pulled By: cpojer fbshipit-source-id: 186cc8d75eccae411b602cb0f68f0e11856e0743
2018-12-10 13:31:24 +03:00
## Running Detox Tests on iOS
Install Detox from [here](https://github.com/wix/Detox/blob/master/docs/Introduction.GettingStarted.md).
To run the e2e tests locally, run the following commands from the react-native folder:
yarn build-ios-e2e
yarn test-ios-e2e
These are the equivalent of running:
detox build -c ios.sim.release
detox test -c ios.sim.release --cleanup
These build the app in Release mode, so the production code is bundled and included in the built app.
When developing E2E tests, you may want to run in development mode, so that changes to the production code show up immediately. To do this, run:
detox build -c ios.sim.debug
detox test -c ios.sim.debug
Metro Bundler -> Metro Summary: This bothers me, we renamed the project to drop the "Metro" a while ago. Reviewed By: rubennorte Differential Revision: D16831281 fbshipit-source-id: bb6de412eccda61b617580f3660e3e635f2d2815
2019-08-16 20:35:31 +03:00
You will also need to have Metro running in another terminal. Note that if you've previously run the E2E tests in release mode, you may need to delete the `RNTester/build` folder before rerunning `detox build`.
Detox debug build (#22572) Summary: Adds a Detox configuration and instructions for running the app in development mode in Detox. This speeds up developing tests, because changes to production code don't require a full rebuild. Pull Request resolved: https://github.com/facebook/react-native/pull/22572 Differential Revision: D13396883 Pulled By: cpojer fbshipit-source-id: 186cc8d75eccae411b602cb0f68f0e11856e0743
2018-12-10 13:31:24 +03:00
fix typo (#24343) Summary: "Built from source" is past tense - if anything, it should be "Build from source". However, all other heading end with "ing" so it makes sense here too. Pull Request resolved: https://github.com/facebook/react-native/pull/24343 Differential Revision: D14822098 Pulled By: cpojer fbshipit-source-id: 3d07f2e6f8ed4a21e0311ef4f675f2d41553b619
2019-04-07 21:31:27 +03:00
## Building from source
Add docs for examples
2015-10-12 18:16:39 +03:00
Building the app on both iOS and Android means building the React Native framework from source. This way you're running the latest native and JS code the way you see it in your clone of the github repo.
This is different from apps created using `react-native init` which have a dependency on a specific version of React Native JS and native code, declared in a `package.json` file (and `build.gradle` for Android apps).