|
| 1 | +## Installing dependencies |
| 2 | + |
| 3 | +You will need Node, Watchman, the React Native command line interface, a JDK, and Android Studio. |
| 4 | + |
| 5 | +While you can use any editor of your choice to develop your app, you will need to install Android Studio in order to set up the necessary tooling to build your React Native app for Android. |
| 6 | + |
| 7 | +<h3>Node & Watchman</h3> |
| 8 | + |
| 9 | +We recommend installing Node and Watchman using [Homebrew](https://brew.sh/). Run the following commands in a Terminal after installing Homebrew: |
| 10 | + |
| 11 | +```shell |
| 12 | +brew install node |
| 13 | +brew install watchman |
| 14 | +``` |
| 15 | + |
| 16 | +If you have already installed Node on your system, make sure it is Node 18 or newer. |
| 17 | + |
| 18 | +[Watchman](https://facebook.github.io/watchman) is a tool by Facebook for watching changes in the filesystem. It is highly recommended you install it for better performance. |
| 19 | + |
| 20 | +<h3>Java Development Kit</h3> |
| 21 | + |
| 22 | +We recommend installing the OpenJDK distribution called Azul **Zulu** using [Homebrew](https://brew.sh/). Run the following commands in a Terminal after installing Homebrew: |
| 23 | + |
| 24 | +```shell |
| 25 | +brew install --cask zulu@17 |
| 26 | + |
| 27 | +# Get path to where cask was installed to double-click installer |
| 28 | +brew info --cask zulu@17 |
| 29 | +``` |
| 30 | + |
| 31 | +After the JDK installation, add or update your `JAVA_HOME` environment variable in `~/.zshrc` (or in `~/.bash_profile`) . |
| 32 | + |
| 33 | +If you used above steps, JDK will likely be located at `/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home`: |
| 34 | + |
| 35 | +```shell |
| 36 | +export JAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-17.jdk/Contents/Home |
| 37 | +``` |
| 38 | + |
| 39 | +The Zulu OpenJDK distribution offers JDKs for **both Intel and M1 Macs**. This will make sure your builds are faster on M1 Macs compared to using an Intel-based JDK. |
| 40 | + |
| 41 | +If you have already installed JDK on your system, we recommend JDK 17. You may encounter problems using higher JDK versions. |
| 42 | + |
| 43 | +<h3>Android development environment</h3> |
| 44 | + |
| 45 | +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. |
| 46 | + |
| 47 | +<h4 id="android-studio">1. Install Android Studio</h4> |
| 48 | + |
| 49 | +[Download and install Android Studio](https://developer.android.com/studio/index.html). While on Android Studio installation wizard, make sure the boxes next to all of the following items are checked: |
| 50 | + |
| 51 | +- `Android SDK` |
| 52 | +- `Android SDK Platform` |
| 53 | +- `Android Virtual Device` |
| 54 | + |
| 55 | +Then, click "Next" to install all of these components. |
| 56 | + |
| 57 | +> If the checkboxes are grayed out, you will have a chance to install these components later on. |
| 58 | +
|
| 59 | +Once setup has finalized and you're presented with the Welcome screen, proceed to the next step. |
| 60 | + |
| 61 | +<h4 id="android-sdk">2. Install the Android SDK</h4> |
| 62 | + |
| 63 | +Android Studio installs the latest Android SDK by default. Building a React Native app with native code, however, requires the `Android 14 (UpsideDownCake)` SDK in particular. Additional Android SDKs can be installed through the SDK Manager in Android Studio. |
| 64 | + |
| 65 | +To do that, open Android Studio, click on "More Actions" button and select "SDK Manager". |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +> The SDK Manager can also be found within the Android Studio "Settings" dialog, under **Languages & Frameworks** → **Android SDK**. |
| 70 | +
|
| 71 | +Select the "SDK Platforms" tab from within the SDK Manager, then check the box next to "Show Package Details" in the bottom right corner. Look for and expand the `Android 14 (UpsideDownCake)` entry, then make sure the following items are checked: |
| 72 | + |
| 73 | +- `Android SDK Platform 34` |
| 74 | +- `Intel x86 Atom_64 System Image` or `Google APIs Intel x86 Atom System Image` or (for Apple M1 Silicon) `Google APIs ARM 64 v8a System Image` |
| 75 | + |
| 76 | +Next, select the "SDK Tools" tab 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 `34.0.0` is selected. |
| 77 | + |
| 78 | +Finally, click "Apply" to download and install the Android SDK and related build tools. |
| 79 | + |
| 80 | +<h4>3. Configure the ANDROID_HOME environment variable</h4> |
| 81 | + |
| 82 | +The React Native tools require some environment variables to be set up in order to build apps with native code. |
| 83 | + |
| 84 | +Add the following lines to your `~/.zprofile` or `~/.zshrc` (if you are using `bash`, then `~/.bash_profile` or `~/.bashrc`) config file: |
| 85 | + |
| 86 | +```shell |
| 87 | +export ANDROID_HOME=$HOME/Library/Android/sdk |
| 88 | +export PATH=$PATH:$ANDROID_HOME/emulator |
| 89 | +export PATH=$PATH:$ANDROID_HOME/platform-tools |
| 90 | +``` |
| 91 | + |
| 92 | +Run `source ~/.zprofile` (or `source ~/.bash_profile` for `bash`) to load the config into your current shell. Verify that ANDROID_HOME has been set by running `echo $ANDROID_HOME` and the appropriate directories have been added to your path by running `echo $PATH`. |
| 93 | + |
| 94 | +> Please make sure you use the correct Android SDK path. You can find the actual location of the SDK in the Android Studio "Settings" dialog, under **Languages & Frameworks** → **Android SDK**. |
| 95 | +
|
| 96 | +<h2>Preparing the Android device</h2> |
| 97 | + |
| 98 | +You will need an Android device to run your React Native Android app. This can be either a physical Android device, or more commonly, you can use an Android Virtual Device which allows you to emulate an Android device on your computer. |
| 99 | + |
| 100 | +Either way, you will need to prepare the device to run Android apps for development. |
| 101 | + |
| 102 | +<h3>Using a physical device</h3> |
| 103 | + |
| 104 | +If you have a physical Android device, you can use it for development in place of an AVD by plugging it in to your computer using a USB cable and following the instructions [here](running-on-device.md). |
| 105 | + |
| 106 | +<h3>Using a virtual device</h3> |
| 107 | + |
| 108 | +If you use Android Studio to open `./AwesomeProject/android`, you can see the list of available Android Virtual Devices (AVDs) by opening the "AVD Manager" from within Android Studio. Look for an icon that looks like this: |
| 109 | + |
| 110 | + |
| 111 | + |
| 112 | +If you have recently installed Android Studio, you will likely need to [create a new AVD](https://developer.android.com/studio/run/managing-avds.html). Select "Create Virtual Device...", then pick any Phone from the list and click "Next", then select the **UpsideDownCake** API Level 34 image. |
| 113 | + |
| 114 | +Click "Next" then "Finish" to create your AVD. At this point you should be able to click on the green triangle button next to your AVD to launch it. |
| 115 | + |
| 116 | +<h3>That's it!</h3> |
| 117 | + |
| 118 | +Congratulations! You successfully set up your development environment. |
| 119 | + |
| 120 | +<center><img src="/docs/assets/GettingStartedCongratulations.png" width="150"></img></center> |
| 121 | + |
| 122 | +<h2>Now what?</h2> |
| 123 | + |
| 124 | +- If you want to add this new React Native code to an existing application, check out the [Integration guide](integration-with-existing-apps.md). |
| 125 | +- If you're curious to learn more about React Native, check out the [Introduction to React Native](getting-started). |
0 commit comments