From e1528a193d963cf7ca41acec0866ee0281672dfb Mon Sep 17 00:00:00 2001 From: Website Deployment Script Date: Thu, 3 Nov 2016 17:05:09 +0000 Subject: [PATCH] Updated docs for next --- releases/next/docs/getting-started.html | 75 +++++++++++++++---------- 1 file changed, 45 insertions(+), 30 deletions(-) diff --git a/releases/next/docs/getting-started.html b/releases/next/docs/getting-started.html index ea5c5b0216a..49d2076f1b1 100644 --- a/releases/next/docs/getting-started.html +++ b/releases/next/docs/getting-started.html @@ -29,75 +29,87 @@ block { display: none; } .display-platform-android.display-os-linux .android.linux, .display-platform-android.display-os-windows .android.windows { display: block; -} +} + Mobile OS: iOS Android Development OS: -Mac +macOS Linux Windows - -

Unsupported #

Unfortunately, Apple only lets you develop for iOS on a Mac. If you want to build an iOS app but you don't have a Mac yet, you can try starting with the Android instructions instead.
- + - +

Installing Dependencies #

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

-

Installing Dependencies #

+

Installing Dependencies #

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

-

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

- -

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

+

Installing Dependencies #

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

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.

+changes in the filesystem. It is highly recommended you install it for better performance.

-

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.

+

Node #

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

-

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 Behavior → System Settings → Android 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, add the following lines to your ~/.bashrc or equivalent config file:

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)".

+

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.

- +

The React Native CLI #

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

-

Installing Dependencies #

+

The React Native CLI #

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

-

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.

+

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.

-

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.

+

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.

-

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 Behavior → System Settings → Android 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.

+

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. Download and install Android Studio #

Android Studio provides the Android SDK and AVD (emulator) required to run and test your React Native apps.

-

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

export ANDROID_HOME=~/Android/Sdk +

Android Studio requires the Java Development Kit (JDK), version 1.8 or higher. You can type javac -version in a terminal to see what version you have, if any.

+ +

2. Install the AVD and HAXM #

Choose Custom installation when running Android Studio for the first time. Make sure the boxes next to all of the following are checked:

  • Android SDK
  • Android SDK Platform
  • Performance (Intel ® HAXM)
  • Android Virtual Device

Then, click "Next" to install all of these components.

If you've already installed Android Studio before, you can still install HAXM without performing a custom installation.

+ +

2. Install the AVD and configure VM acceleration #

Choose Custom installation when running Android Studio for the first time. Make sure the boxes next to all of the following are checked:

  • Android SDK
  • Android SDK Platform
  • Android Virtual Device

Click "Next" to install all of these components, then configure VM acceleration on your system.

+ +

3. Install the Android 6.0 (Marshmallow) SDK #

Android Studio installs the most recent Android SDK by default. React Native, however, requires the Android 6.0 (Marshmallow) SDK. To install it, launch the SDK Manager, click on "Configure" in the "Welcome to Android Studio" screen.

The SDK Manager can also be found within the Android Studio "Preferences" menu, under Appearance & Behavior → System Settings → Android SDK.

Select "SDK Platforms" from within the SDK Manager, then check the box next to "Show Package Details". Look for and expand the Android 6.0 (Marshmallow) entry, then make sure the following items are all checked:

  • Google APIs
  • Intel x86 Atom System Image
  • Intel x86 Atom_64 System Image
  • Google APIs Intel x86 Atom_64 System Image

Next, select "SDK Tools" and check the box next to "Show Package Details" here as well. Look for and expand the "Android SDK Build Tools" entry, then make sure that Android SDK Build-Tools 23.0.1 is selected.

Finally, click "Apply" to download and install the Android SDK and related build tools.

+ +

4. Set up the ANDROID_HOME environment variable #

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

+ +

Add the following lines to your ~/.bashrc (or equivalent) config file:

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

The second line will add the android tool to your path, which will come in handy in the next step. The third line will add the adb tool to your path, which is used to communicate with your Android device / emulator.

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

+export PATH=${PATH}:${ANDROID_HOME}/platform-tools

Please make sure you export the correct path for ANDROID_HOME. If you installed the Android SDK using Homebrew, it would be located at /usr/local/opt/android-sdk.

-

Go to Control Panel → System and Security → System → Change settings → -Advanced System Settings → Environment variables → New, 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.

+

Add the following lines to your ~/.bashrc (or equivalent) config file:

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

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

-

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)".

+

Go to Control Panel → System and Security → System → Change settings → +Advanced System Settings → Environment variables → New, then enter the path to your Android SDK.

env variable

Restart the Command Prompt to apply the new environment variable.

+ +

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

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.

+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.

+ +

Starting the Android Virtual Device #

Android Studio AVD Manager

You can see the list of available AVDs by opening the "AVD Manager" from within Android Studio. You can also run the following command in a terminal:

android avd

Once in the "AVD Manager", select your AVD and click "Start...".

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. You may follow the Android Studio User Guide to create a new AVD manually if needed.

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-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 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 +

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.

+react-native run-android

If everything is set up correctly, you should see your new app running in your AVD 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.

Modifying your app #

Now that you have successfully run the app, let's modify it.

@@ -118,7 +130,10 @@ react-native run

Modifying your app #

Now that you have successfully run the app, let's modify it.

  • Open index.android.js in your text editor of choice and edit some lines.
  • Press the R key twice or select Reload from the Developer Menu to see your change!

That's it! #

Congratulations! You've successfully run and modified a React Native app.

- + + +

Now What? #

  • If you want to add this new React Native code to an existing application, check out the Integration guide.

  • If you can't get this to work, see the Troubleshooting page.

  • If you're curious to learn more about React Native, continue on +to the Tutorial.

Now What? #

  • If you want to add this new React Native code to an existing application, check out the Integration guide.

  • If you can't get this to work, see the Troubleshooting page.

  • If you're curious to learn more about React Native, continue on to the Tutorial.