status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
react-native/RNTester/README.md

89 lines
3.2 KiB
Markdown
Raw Permalink Normal View History

Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 03:50:47 +00:00
# RNTester
Add docs for examples
2015-10-12 15:16:39 +00:00
Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 03:50:47 +00:00
The RNTester showcases React Native views and modules.
Add docs for examples
2015-10-12 15:16:39 +00:00
## Running this app
Before running the app, make sure you ran:
Add git clone step to READMEs
2015-11-17 03:55:45 +00:00
git clone https://github.com/facebook/react-native.git
Add docs for examples
2015-10-12 15:16:39 +00:00
cd react-native
npm install
### Running on iOS
Mac OS and Xcode are required.
Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 03:50:47 +00:00
- Open `RNTester/RNTester.xcodeproj` in Xcode
Add docs for examples
2015-10-12 15:16:39 +00:00
- Hit the Run button
Consolidate Running on Device (Android|iOS) Guides into one Summary: The RunningOnDeviceAndroid doc had some Linux-specific instructions that are not relevant to macOS/Windows users. Closes https://github.com/facebook/react-native/pull/10726 Differential Revision: D4139089 Pulled By: JoelMarcey fbshipit-source-id: cc57c1d7e3c9dec94e123c3597ac78b3efb15dd0
2016-11-07 05:03:16 +00:00
See [Running on device](https://facebook.github.io/react-native/docs/running-on-device.html) if you want to use a physical device.
Add docs for examples
2015-10-12 15:16:39 +00:00
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-12 22:54:36 +00:00
### Running on iOS with CocoaPods
Similar to above, you can build the app via Xcode with help of CocoaPods.
- Install [CocoaPods](http://facebook.github.io/react-native/docs/integration-with-existing-apps.html#3-install-cocoapods)
- Run `cd RNTester; pod install`
- Open the generated `RNTesterPods.xcworkspace` (this is not checked in). Do not open `RNTesterPods.xcodeproj` directly.
Add docs for examples
2015-10-12 15:16:39 +00: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.
Start an Android emulator ([Genymotion](https://www.genymotion.com) is recommended).
cd react-native
Re-license and rename UIExplorer integration test app as RNTester Reviewed By: yungsters Differential Revision: D4950085 fbshipit-source-id: 44574b5d0ef0d2ad5dfc714309b18dc69cbad9ff
2017-05-06 03:50:47 +00:00
./gradlew :RNTester:android:app:installDebug
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-23 23:05:52 +00:00
./scripts/packager.sh
Add docs for examples
2015-10-12 15:16:39 +00: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 03:50:47 +00:00
Open the RNTester app in your emulator.
Add docs for examples
2015-10-12 15:16:39 +00:00
Consolidate Running on Device (Android|iOS) Guides into one Summary: The RunningOnDeviceAndroid doc had some Linux-specific instructions that are not relevant to macOS/Windows users. Closes https://github.com/facebook/react-native/pull/10726 Differential Revision: D4139089 Pulled By: JoelMarcey fbshipit-source-id: cc57c1d7e3c9dec94e123c3597ac78b3efb15dd0
2016-11-07 05:03:16 +00:00
See [Running on Device](https://facebook.github.io/react-native/docs/running-on-device.html) in case you want to use a physical device.
Add docs for examples
2015-10-12 15:16:39 +00: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 20:03:54 +00: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 03:50:47 +00: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-23 23:05:52 +00: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 20:03:54 +00: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 10:31:24 +00: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
You will also need to have Metro Bundler 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`.
Add docs for examples
2015-10-12 15:16:39 +00:00
## Built from source
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).