diff --git a/releases/next/docs/getting-started.html b/releases/next/docs/getting-started.html index b8e9db9dc6a..8008d5b1491 100644 --- a/releases/next/docs/getting-started.html +++ b/releases/next/docs/getting-started.html @@ -49,48 +49,52 @@ block { display: none; } - + -

Dependencies for Mac + iOS #

You will need Xcode, node.js, the React Native command line tools, and Watchman.

+

Installing Dependencies #

-

Dependencies for Mac + Android #

You will need Android Studio, node.js, the React Native command line tools, and Watchman.

+

You will need Node.js, Watchman, the React Native command line interface, and Xcode.

-

We recommend installing node and watchman via Homebrew.

brew install node -brew install watchman

Node comes with npm, which lets you install the React Native command line interface.

npm install -g react-native-cli

If you get a permission error, try with sudo: sudo npm install -g react-native-cli.

If you get error Cannot find module 'npmlog', try this before: curl -0 -L http://npmjs.org/install.sh | sudo sh.

+

You will need Node.js, Watchman, the React Native command line interface, and Android Studio.

-

The easiest way to install Xcode is via the Mac App Store.

+

Node, Watchman #

We recommend installing Node and Watchman using Homebrew. Run the following commands in a Terminal after installing Homebrew:

brew install node +brew install watchman

Watchman is a tool by Facebook for watching +changes in the filesystem. It is highly recommended you install it for better performance.

The React Native CLI #

Node.js comes with npm, which lets you install the React Native command line interface. Run the following command in a Terminal:

npm install -g react-native-cli

If you get a permission error, try using sudo: sudo npm install -g react-native-cli.

If you get an error like Cannot find module 'npmlog', try installing npm directly: curl -0 -L http://npmjs.org/install.sh | sudo sh.

-

Download and install Android Studio.

If you plan to make changes in Java code, we recommend Gradle Daemon which speeds up the build.

+

Xcode #

The easiest way to install Xcode is via the Mac App Store. Installing Xcode will also install the iOS Simulator and all the necessary tools to build your iOS app.

- +

Android Development Environment #

Setting up your development environment can be somewhat tedious if you're new to Android development. If you're already familiar with Android development, there are a few things you may need to configure. In either case, please make sure to carefully follow the next few steps.

1. Install Android Studio #

Download and install Android Studio.

2. Confirm the Android SDK is installed #

Android Studio installs Android 7.0 (Nougat) by default. You can confirm that the SDK was installed by clicking on "Configure" in the last screen in the Android Studio Setup Wizard, or by opening "Preferences" from the Android Studio menu, then choosing Appearance and BehaviorSystem SettingsAndroid SDK.

Android Studio SDK Manager

Select "SDK Platforms" from within the SDK Manager and you should see a blue checkmark next to "Android 7.0 (Nougat)". In case it is not, click on the checkbox and then "Apply".

Android Studio SDK Manager

If you wish to support older versions of Android, you can install additional Android SDKs from this screen.

3. Set up paths #

The React Native command line interface requires the ANDROID_HOME environment variable to be set up. You can configure it in a Terminal using the following command:

export ANDROID_HOME=~/Library/Android/sdk

To avoid doing this every time you open a new Terminal, create (or edit) ~/.bashrc using your favorite text editor and add the following lines:

export ANDROID_HOME=~/Library/Android/sdk +export PATH=${PATH}:${ANDROID_HOME}/tools

The second line will add the android tool to your path, which will come in handy in the next step.

Please make sure you export the correct path for ANDROID_HOME if you did not install the Android SDK using Android Studio. If you install the Android SDK using Homebrew, it will be located at /usr/local/opt/android-sdk.

4. Set up your Android Virtual Device #

Android Studio should have set up an Android Virtual Device for you during installation, but it is very common to run into an issue where Android Studio fails to install the AVD.

Android Studio AVD Manager

To see the list of available AVDs, launch the "AVD Manager" from within Android Studio or run the following command in a Terminal:

android avd

You may follow the Android Studio User Guide to create a new AVD if needed.

If you see "No system images installed for this target." under CPU/ABI, go back to your "SDK Manager" and click on "Show Package Details" under "SDK Platforms". You will then be able to install any missing system images, such as "Google APIs Intel Atom (x86)".

-

Dependencies for Linux + Android #

+ -

Dependencies for Windows + Android #

+

Installing Dependencies #

-

You will need node.js, the React Native command line tools, Watchman, and Android Studio.

+

You will need Node.js, the React Native command line interface, and Android Studio.

Node #

Follow the installation instructions for your Linux distribution to install Node.js 4 or newer.

-

Follow the installation instructions for your Linux distribution to install Node.js 4 or newer.

+

You will need Node.js, the React Native command line interface, and Android Studio.

Node #

We recommend installing Node.js and Python2 via Chocolatey, a popular package manager for Windows. Open a Command Prompt as Administrator, then run:

choco install nodejs.install +choco install python2

You can find additional installation options on Node.js's Downloads page.

-

We recommend installing node.js and Python2 via Chocolatey, a popular package manager for Windows. Open a Command Prompt as Administrator, then run:

choco install nodejs.install -choco install python2
+

The React Native CLI #

Node comes with npm, which lets you install the React Native command line interface.

npm install -g react-native-cli

Android Development Environment #

Setting up your development environment can be somewhat tedious if you're new to Android development. If you're already familiar with Android development, there are a few things you may need to configure. In either case, please make sure to carefully follow the next few steps.

1. Install Android Studio #

Download and install Android Studio.

2. Confirm the Android SDK is installed #

Android Studio installs Android 7.0 (Nougat) by default. You can confirm that the SDK was installed by clicking on "Configure" in the last screen in the Android Studio Setup Wizard, or by opening "Preferences" from the Android Studio menu, then choosing Appearance and BehaviorSystem SettingsAndroid SDK.

Android Studio SDK Manager

Select "SDK Platforms" from within the SDK Manager and you should see a blue checkmark next to "Android 7.0 (Nougat)". In case it is not, click on the checkbox and then "Apply".

Android Studio SDK Manager

If you wish to support older versions of Android, you can install additional Android SDKs from this screen.

3. Set up paths #

The React Native command line interface requires the ANDROID_HOME environment variable to be set up.

-

Node comes with npm, which lets you install the React Native command line interface.

npm install -g react-native-cli
+

Create or edit your ~/.bashrc file and add the following lines:

export ANDROID_HOME=~/Android/Sdk +export PATH=${PATH}:${ANDROID_HOME}/tools

The second line will add the android tool to your path, which will come in handy in the next step.

Please make sure you export the correct path for ANDROID_HOME if you did not install the Android SDK using Android Studio.

-

Download and install Android Studio.

+

Go to Control PanelSystem and SecuritySystemChange settings → +Advanced System SettingsEnvironment variablesNew, then enter the path to your Android SDK.

env variable

Please make sure you use the correct path for ANDROID_HOME if you did not install the Android SDK using Android Studio.

Restart the Command Prompt to apply the new environment variable.

-

Watchman is a tool by Facebook for watching changes in the filesystem. Installing it should -improve performance, but you can also try not installing it, if the installation process is too annoying. You can follow the Watchman installation guide to compile and install from source.

+

4. Set up your Android Virtual Device #

Android Studio should have set up an Android Virtual Device for you during installation, but it is very common to run into an issue where Android Studio fails to install the AVD.

Android Studio AVD Manager

To see the list of available AVDs, launch the "AVD Manager" from within Android Studio or run the following command in a terminal:

android avd

You may follow the Android Studio User Guide to create a new AVD if needed.

If you see "No system images installed for this target." under CPU/ABI, go back to your "SDK Manager" and click on "Show Package Details" under "SDK Platforms". You will then be able to install any missing system images, such as "Google APIs Intel Atom (x86)".

-

If you plan to make changes in Java code, we recommend Gradle Daemon which speeds up the build.

+

Watchman (optional) #

Follow the Watchman installation guide to compile and install Watchman from source.

Watchman is a tool by Facebook for watching +changes in the filesystem. It is highly recommended you install it for better performance, but it's alright to skip this if you find the process to be tedious.

Testing your React Native Installation #

-

Use the React Native command line tools to generate a new React Native project called "AwesomeProject", then run react-native run-ios inside the newly created folder.

react-native init AwesomeProject +

Use the React Native command line interface to generate a new React Native project called "AwesomeProject", then run react-native run-ios inside the newly created folder.

react-native init AwesomeProject cd AwesomeProject -react-native run-ios

You should see your new app running in the iOS Simulator shortly. react-native run-ios is just one way to run your app - you can also run it directly from within Xcode or Nuclide.

+react-native run-ios

You should see your new app running in the iOS Simulator shortly.

react-native run-ios is just one way to run your app. You can also run it directly from within Xcode or Nuclide.

-

Use the React Native command line tools to generate a new React Native project called "AwesomeProject", then run react-native run-android inside the newly created folder.

react-native init AwesomeProject +

Use the React Native command line interface to generate a new React Native project called "AwesomeProject", then run react-native run-android inside the newly created folder.

react-native init AwesomeProject cd AwesomeProject react-native run-android

If everything is set up correctly, you should see your new app running in your Android emulator shortly. react-native run-android is just one way to run your app - you can also run it directly from within Android Studio or Nuclide.

@@ -104,7 +108,7 @@ react-native run -

Testing your React Native Installation #

Use the React Native command line tools to generate a new React Native project called "AwesomeProject", then run react-native run-android inside the newly created folder.

react-native init AwesomeProject +

Testing your React Native Installation #

Use the React Native command line interface to generate a new React Native project called "AwesomeProject", then run react-native run-android inside the newly created folder.

react-native init AwesomeProject cd AwesomeProject react-native run-android

If everything is set up correctly, you should see your new app running in your Android emulator shortly.

A common issue is that the packager is not started automatically when you run react-native run-android. You can start it manually using react-native start.

diff --git a/releases/next/docs/native-modules-android.html b/releases/next/docs/native-modules-android.html index 185bd370462..5013b08fb64 100644 --- a/releases/next/docs/native-modules-android.html +++ b/releases/next/docs/native-modules-android.html @@ -1,4 +1,4 @@ -Native Modules

Native Modules #

Sometimes an app needs access to a platform API that React Native doesn't have a corresponding module for yet. Maybe you want to reuse some existing Java code without having to reimplement it in JavaScript, or write some high performance, multi-threaded code such as for image processing, a database, or any number of advanced extensions.

We designed React Native such that it is possible for you to write real native code and have access to the full power of the platform. This is a more advanced feature and we don't expect it to be part of the usual development process, however it is essential that it exists. If React Native doesn't support a native feature that you need, you should be able to build it yourself.

The Toast Module #

This guide will use the Toast example. Let's say we would like to be able to create a toast message from JavaScript.

We start by creating a native module. A native module is a Java class that usually extends the ReactContextBaseJavaModule class and implements the functionality required by the JavaScript. Our goal here is to be able to write ToastAndroid.show('Awesome', ToastAndroid.SHORT); from JavaScript to display a short toast on the screen.

package com.facebook.react.modules.toast; +Native Modules

Native Modules #

Sometimes an app needs access to a platform API that React Native doesn't have a corresponding module for yet. Maybe you want to reuse some existing Java code without having to reimplement it in JavaScript, or write some high performance, multi-threaded code such as for image processing, a database, or any number of advanced extensions.

We designed React Native such that it is possible for you to write real native code and have access to the full power of the platform. This is a more advanced feature and we don't expect it to be part of the usual development process, however it is essential that it exists. If React Native doesn't support a native feature that you need, you should be able to build it yourself.

Enable Gradle #

If you plan to make changes in Java code, we recommend enabling Gradle Daemon to speed up builds.

The Toast Module #

This guide will use the Toast example. Let's say we would like to be able to create a toast message from JavaScript.

We start by creating a native module. A native module is a Java class that usually extends the ReactContextBaseJavaModule class and implements the functionality required by the JavaScript. Our goal here is to be able to write ToastAndroid.show('Awesome', ToastAndroid.SHORT); from JavaScript to display a short toast on the screen.

package com.facebook.react.modules.toast; import android.widget.Toast; diff --git a/releases/next/img/react-native-sdk-platforms.png b/releases/next/img/react-native-sdk-platforms.png new file mode 100644 index 00000000000..51d0317cfac Binary files /dev/null and b/releases/next/img/react-native-sdk-platforms.png differ diff --git a/releases/next/img/react-native-tools-avd.png b/releases/next/img/react-native-tools-avd.png new file mode 100644 index 00000000000..66683ddd259 Binary files /dev/null and b/releases/next/img/react-native-tools-avd.png differ