Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate React Native website to Docusaurus V2 (#2263)
Co-authored-by: Bartosz Kaszubowski <gosimek@gmail.com> Co-authored-by: slorber <lorber.sebastien@gmail.com> Co-authored-by: Darsh <darshkpatel@gmail.com> Co-authored-by: teikjun <teikjunhci@gmail.com> Co-authored-by: Teik Jun <tanteikjun@gmail.com> Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
- Loading branch information
6 people
committed
Oct 29, 2020
1 parent
467706b
commit e622c6a
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| ## Installing dependencies | ||
|
|
||
| You will need Node, the React Native command line interface, a JDK, and Android Studio. | ||
|
|
||
| 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. | ||
|
|
||
| <h3>Node</h3> | ||
|
|
||
| Follow the [installation instructions for your Linux distribution](https://nodejs.org/en/download/package-manager/) to install Node 10 or newer. | ||
|
|
||
| <h3>Java Development Kit</h3> | ||
|
|
||
| React Native requires at least the version 8 of the Java SE Development Kit (JDK). You may download and install [OpenJDK](http://openjdk.java.net) from [AdoptOpenJDK](https://adoptopenjdk.net/) or your system packager. You may also [Download and install Oracle JDK 14](https://www.oracle.com/java/technologies/javase-jdk14-downloads.html) if desired. | ||
|
|
||
| <h3>Android development environment</h3> | ||
|
|
||
| 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. | ||
|
|
||
| <h4>1. Install Android Studio</h4> | ||
|
|
||
| [Download and install Android Studio](https://developer.android.com/studio/index.html). While on Android Studio intallation wizard, make sure the boxes next to all of the following items are checked: | ||
|
|
||
| - `Android SDK` | ||
| - `Android SDK Platform` | ||
| - `Android Virtual Device` | ||
This comment has been minimized.
Sorry, something went wrong. |
||
|
|
||
| Then, click "Next" to install all of these components. | ||
|
|
||
| > If the checkboxes are grayed out, you will have a chance to install these components later on. | ||
| Once setup has finalized and you're presented with the Welcome screen, proceed to the next step. | ||
|
|
||
| <h4>2. Install the Android SDK</h4> | ||
|
|
||
| Android Studio installs the latest Android SDK by default. Building a React Native app with native code, however, requires the `Android 10 (Q)` SDK in particular. Additional Android SDKs can be installed through the SDK Manager in Android Studio. | ||
|
|
||
| To do that, open Android Studio, click on "Configure" button and select "SDK Manager". | ||
|
|
||
| > The SDK Manager can also be found within the Android Studio "Preferences" dialog, under **Appearance & Behavior** → **System Settings** → **Android SDK**. | ||
| 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 10 (Q)` entry, then make sure the following items are checked: | ||
|
|
||
| - `Android SDK Platform 29` | ||
| - `Intel x86 Atom_64 System Image` or `Google APIs Intel x86 Atom System Image` | ||
|
|
||
| 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 `29.0.2` is selected. | ||
|
|
||
| Finally, click "Apply" to download and install the Android SDK and related build tools. | ||
|
|
||
| <h4>3. Configure the ANDROID_HOME environment variable</h4> | ||
|
|
||
| The React Native tools require some environment variables to be set up in order to build apps with native code. | ||
|
|
||
| Add the following lines to your `$HOME/.bash_profile` or `$HOME/.bashrc` (if you are using `zsh` then `~/.zprofile` or `~/.zshrc`) config file: | ||
|
|
||
| ```shell | ||
| export ANDROID_HOME=$HOME/Android/Sdk | ||
| export PATH=$PATH:$ANDROID_HOME/emulator | ||
| export PATH=$PATH:$ANDROID_HOME/tools | ||
| export PATH=$PATH:$ANDROID_HOME/tools/bin | ||
| export PATH=$PATH:$ANDROID_HOME/platform-tools | ||
| ``` | ||
|
|
||
| > `.bash_profile` is specific to `bash`. If you're using another shell, you will need to edit the appropriate shell-specific config file. | ||
| Type `source $HOME/.bash_profile` for `bash` or `source $HOME/.zprofile` 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`. | ||
|
|
||
| > Please make sure you use the correct Android SDK path. You can find the actual location of the SDK in the Android Studio "Preferences" dialog, under **Appearance & Behavior** → **System Settings** → **Android SDK**. | ||
| <h3>Watchman</h3> | ||
|
|
||
| Follow the [Watchman installation guide](https://facebook.github.io/watchman/docs/install/#buildinstall) to compile and install Watchman from source. | ||
|
|
||
| > [Watchman](https://facebook.github.io/watchman/docs/install/) is a tool by Facebook for watching changes in the filesystem. It is highly recommended you install it for better performance and increased compatibility in certain edge cases (translation: you may be able to get by without installing this, but your mileage may vary; installing this now may save you from a headache later). | ||
| <h3>React Native Command Line Interface</h3> | ||
|
|
||
| React Native has a built-in command line interface. Rather than install and manage a specific version of the CLI globally, we recommend you access the current version at runtime using `npx`, which ships with Node.js. With `npx react-native <command>`, the current stable version of the CLI will be downloaded and executed at the time the command is run. | ||
|
|
||
| <h2>Creating a new application</h2> | ||
|
|
||
| > If you previously installed a global `react-native-cli` package, please remove it as it may cause unexpected issues. | ||
| React Native has a built-in command line interface, which you can use to generate a new project. You can access it without installing anything globally using `npx`, which ships with Node.js. Let's create a new React Native project called "AwesomeProject": | ||
|
|
||
| ```shell | ||
| npx react-native init AwesomeProject | ||
| ``` | ||
|
|
||
| This is not necessary if you are integrating React Native into an existing application, if you "ejected" from Expo, or if you're adding Android support to an existing React Native project (see [Platform Specific Code](platform-specific-code.md)). You can also use a third-party CLI to init your React Native app, such as [Ignite CLI](https://github.com/infinitered/ignite). | ||
|
|
||
| <h3>[Optional] Using a specific version or template</h3> | ||
|
|
||
| If you want to start a new project with a specific React Native version, you can use the `--version` argument: | ||
|
|
||
| ```shell | ||
| npx react-native init AwesomeProject --version X.XX.X | ||
| ``` | ||
|
|
||
| You can also start a project with a custom React Native template, like TypeScript, with `--template` argument: | ||
|
|
||
| ```shell | ||
| npx react-native init AwesomeTSProject --template react-native-template-typescript | ||
| ``` | ||
|
|
||
| <h2>Preparing the Android device</h2> | ||
|
|
||
| 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. | ||
|
|
||
| Either way, you will need to prepare the device to run Android apps for development. | ||
|
|
||
| <h3>Using a physical device</h3> | ||
|
|
||
| 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). | ||
|
|
||
| <h3>Using a virtual device</h3> | ||
|
|
||
| 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: | ||
|
|
||
|  | ||
|
|
||
| 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 **Q** API Level 29 image. | ||
|
|
||
| > We recommend configuring [VM acceleration](https://developer.android.com/studio/run/emulator-acceleration.html#vm-linux) on your system to improve performance. Once you've followed those instructions, go back to the AVD Manager. | ||
| 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, then proceed to the next step. | ||
|
|
||
| <h2>Running your React Native application</h2> | ||
|
|
||
| <h3>Step 1: Start Metro</h3> | ||
|
|
||
| First, you will need to start Metro, the JavaScript bundler that ships with React Native. Metro "takes in an entry file and various options, and returns a single JavaScript file that includes all your code and its dependencies."—[Metro Docs](https://facebook.github.io/metro/docs/concepts) | ||
|
|
||
| To start Metro, run `npx react-native start` inside your React Native project folder: | ||
|
|
||
| ```shell | ||
| npx react-native start | ||
| ``` | ||
|
|
||
| `react-native start` starts Metro Bundler. | ||
|
|
||
| > If you use the Yarn package manager, you can use `yarn` instead of `npx` when running React Native commands inside an existing project. | ||
| > If you're familiar with web development, Metro is a lot like webpack—for React Native apps. Unlike Kotlin or Java, JavaScript isn't compiled—and neither is React Native. Bundling isn't the same as compiling, but it can help improve startup performance and translate some platform-specific JavaScript into more JavaScript. | ||
| <h3>Step 2: Start your application</h3> | ||
|
|
||
| Let Metro Bundler run in its own terminal. Open a new terminal inside your React Native project folder. Run the following: | ||
|
|
||
| ```shell | ||
| npx react-native run-android | ||
| ``` | ||
|
|
||
| If everything is set up correctly, you should see your new app running in your Android emulator shortly. | ||
|
|
||
| `npx react-native run-android` is one way to run your app - you can also run it directly from within Android Studio. | ||
|
|
||
| > If you can't get this to work, see the [Troubleshooting](troubleshooting.md#content) page. | ||
| <h3>Modifying your app</h3> | ||
|
|
||
| Now that you have successfully run the app, let's modify it. | ||
|
|
||
| - Open `App.js` in your text editor of choice and edit some lines. | ||
| - Press the `R` key twice or select `Reload` from the Developer Menu (`Ctrl + M`) to see your changes! | ||
|
|
||
| <h3>That's it!</h3> | ||
|
|
||
| Congratulations! You've successfully run and modified your first React Native app. | ||
|
|
||
| <center><img src="/docs/assets/GettingStartedCongratulations.png" width="150"></img></center> | ||
|
|
||
| <h2>Now what?</h2> | ||
|
|
||
| - If you want to add this new React Native code to an existing application, check out the [Integration guide](integration-with-existing-apps.md). | ||
|
|
||
| If you're curious to learn more about React Native, check out the [Introduction to React Native](getting-started). | ||
Oops, something went wrong.
I don’t have any money