Skip to content

Commit 8abfb5e

Browse files
author
Martin Konicek
committed
Add docs for examples
1 parent cab3bd6 commit 8abfb5e

2 files changed

Lines changed: 82 additions & 0 deletions

File tree

Examples/Movies/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Movies app
2+
3+
The Movies app is a demonstration of basic concepts, such as fetching data, rendering a list of data including images, and navigating between different screens.
4+
5+
## Running this app
6+
7+
Before running the app, make sure you ran:
8+
9+
cd react-native
10+
npm install
11+
12+
### Running on iOS
13+
14+
Mac OS and Xcode are required.
15+
16+
- Open `Examples/Movies/Movies.xcodeproj` in Xcode
17+
- Hit the Run button
18+
19+
See [Running on device](https://facebook.github.io/react-native/docs/running-on-device-ios.html) if you want to use a physical device.
20+
21+
### Running on Android
22+
23+
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.
24+
25+
Start an Android emulator ([Genymotion](https://www.genymotion.com) is recommended).
26+
27+
cd react-native
28+
./gradlew :Examples:Movies:android:app:installDebug
29+
./packager/packager.sh
30+
31+
_Note: Building for the first time can take a while._
32+
33+
Open the Movies app in your emulator.
34+
35+
See [Running on Device](https://facebook.github.io/react-native/docs/running-on-device-android.html) in case you want to use a physical device.
36+
37+
## Built from source
38+
39+
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.
40+
41+
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).

Examples/UIExplorer/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# UIExplorer
2+
3+
The UIExplorer is a sample app that showcases React Native views and modules.
4+
5+
## Running this app
6+
7+
Before running the app, make sure you ran:
8+
9+
cd react-native
10+
npm install
11+
12+
### Running on iOS
13+
14+
Mac OS and Xcode are required.
15+
16+
- Open `Examples/UIExplorer/UIExplorer.xcodeproj` in Xcode
17+
- Hit the Run button
18+
19+
See [Running on device](https://facebook.github.io/react-native/docs/running-on-device-ios.html) if you want to use a physical device.
20+
21+
### Running on Android
22+
23+
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.
24+
25+
Start an Android emulator ([Genymotion](https://www.genymotion.com) is recommended).
26+
27+
cd react-native
28+
./gradlew :Examples:UIExplorer:android:app:installDebug
29+
./packager/packager.sh
30+
31+
_Note: Building for the first time can take a while._
32+
33+
Open the UIExplorer app in your emulator.
34+
35+
See [Running on Device](https://facebook.github.io/react-native/docs/running-on-device-android.html) in case you want to use a physical device.
36+
37+
## Built from source
38+
39+
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.
40+
41+
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).

0 commit comments

Comments
 (0)