diff --git a/docs/getting-started.html b/docs/getting-started.html index 4252b38bf0f..9ce7aad9ac1 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -120,16 +120,16 @@

-

Create React Native App is the easiest way to start building a new React Native application. It allows you to start a project without installing or configuring any tools to build native code - no Xcode or Android Studio installation required (see Caveats).

-

Assuming that you have Node installed, you can use npm to install the create-react-native-app command line utility:

-
npm install -g create-react-native-app
+
Expo is the easiest way to start building a new React Native application. It allows you to start a project without installing or configuring any tools to build native code - no Xcode or Android Studio installation required (see Caveats).

+
Assuming that you have Node installed, you can use npm to install the Expo CLI command line utility:

+
npm install -g expo-cli
 

 
Then run the following commands to create a new React Native project called "AwesomeProject":

-
create-react-native-app AwesomeProject
-
-cd AwesomeProject
-npm start
-

+
expo init AwesomeProject
+
+cd AwesomeProject
+npm start
+

 
This will start a development server for you.

 
Running your React Native application

 
Install the Expo client app on your iOS or Android phone and connect to the same wireless network as your computer. On Android, use the Expo app to scan the QR code from your terminal to open your project. On iOS, follow on-screen instructions to get a link.

@@ -139,21 +139,23 @@
 
Congratulations! You've successfully run and modified your first React Native app.

 

 
Now what?

+
Expo also has docs you can reference if you have questions specific to the tool. You can also ask for help at Expo forums.

+
If you have a problem with Expo, before creating a new issue, please see if there's an existing issue about it:

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

 
Running your app on a simulator or virtual device

-
Create React Native App makes it really easy to run your React Native app on a physical device without setting up a development environment. If you want to run your app on the iOS Simulator or an Android Virtual Device, please refer to the instructions for building projects with native code to learn how to install Xcode and set up your Android development environment.

+
Expo CLI makes it really easy to run your React Native app on a physical device without setting up a development environment. If you want to run your app on the iOS Simulator or an Android Virtual Device, please refer to the instructions for building projects with native code to learn how to install Xcode and set up your Android development environment.

 
Once you've set these up, you can launch your app on an Android Virtual Device by running npm run android, or on the iOS Simulator by running npm run ios (macOS only).

 
Caveats

-
Because you don't build any native code when using Create React Native App to create a project, it's not possible to include custom native modules beyond the React Native APIs and components that are available in the Expo client app.

-
If you know that you'll eventually need to include your own native code, Create React Native App is still a good way to get started. In that case you'll just need to "eject" eventually to create your own native builds. If you do eject, the "Building Projects with Native Code" instructions will be required to continue working on your project.

-
Create React Native App configures your project to use the most recent React Native version that is supported by the Expo client app. The Expo client app usually gains support for a given React Native version about a week after the React Native version is released as stable. You can check this document to find out what versions are supported.

-
If you're integrating React Native into an existing project, you'll want to skip Create React Native App and go directly to setting up the native build environment. Select "Building Projects with Native Code" above for instructions on configuring a native build environment for React Native.

+
Because you don't build any native code when using Expo to create a project, it's not possible to include custom native modules beyond the React Native APIs and components that are available in the Expo client app.

+
If you know that you'll eventually need to include your own native code, Expo is still a good way to get started. In that case you'll just need to "eject" eventually to create your own native builds. If you do eject, the "Building Projects with Native Code" instructions will be required to continue working on your project.

+
Expo CLI configures your project to use the most recent React Native version that is supported by the Expo client app. The Expo client app usually gains support for a given React Native version about a week after the React Native version is released as stable. You can check this document to find out what versions are supported.

+
If you're integrating React Native into an existing project, you'll want to skip Expo CLI and go directly to setting up the native build environment. Select "Building Projects with Native Code" above for instructions on configuring a native build environment for React Native.

 

-
Follow these instructions if you need to build native code in your project. For example, if you are integrating React Native into an existing application, or if you "ejected" from Create React Native App, you'll need this section.

+
Follow these instructions if you need to build native code in your project. For example, if you are integrating React Native into an existing application, or if you "ejected" from Expo/a> or Create React Native App, you'll need this section.

 
The instructions are a bit different depending on your development operating system, and whether you want to start developing for iOS or Android. If you want to develop for both iOS and Android, that's fine - you just have to pick one to start with, since the setup is a bit different.

 

   Development OS:
@@ -166,7 +168,7 @@
 

 

 
Unsupported

-
A Mac is required to build projects with native code for iOS. You can follow the Quick Start to learn how to build your app using Create React Native App instead.

+
A Mac is required to build projects with native code for iOS. You can follow the Quick Start to learn how to build your app using Expo instead.

 

 
Installing dependencies

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

@@ -335,7 +337,7 @@
 
Use the React Native command line interface to generate a new React Native project called "AwesomeProject":

 
react-native init AwesomeProject
 

-
This is not necessary if you are integrating React Native into an existing application, if you "ejected" from Create React Native App, or if you're adding iOS support to an existing React Native project (see Platform Specific Code).

+
This is not necessary if you are integrating React Native into an existing application, if you "ejected" from Expo (or Create React Native App), or if you're adding iOS support to an existing React Native project (see Platform Specific Code).

 

 
Creating a new application

 
Use the React Native command line interface to generate a new React Native project called "AwesomeProject":

diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html
index 4252b38bf0f..9ce7aad9ac1 100644
--- a/docs/getting-started/index.html
+++ b/docs/getting-started/index.html
@@ -120,16 +120,16 @@
   
 
 

-
Create React Native App is the easiest way to start building a new React Native application. It allows you to start a project without installing or configuring any tools to build native code - no Xcode or Android Studio installation required (see Caveats).

-
Assuming that you have Node installed, you can use npm to install the create-react-native-app command line utility:

-
npm install -g create-react-native-app
+
Expo is the easiest way to start building a new React Native application. It allows you to start a project without installing or configuring any tools to build native code - no Xcode or Android Studio installation required (see Caveats).

+
Assuming that you have Node installed, you can use npm to install the Expo CLI command line utility:

+
npm install -g expo-cli
 

 
Then run the following commands to create a new React Native project called "AwesomeProject":

-
create-react-native-app AwesomeProject
-
-cd AwesomeProject
-npm start
-

+
expo init AwesomeProject
+
+cd AwesomeProject
+npm start
+

 
This will start a development server for you.

 
Running your React Native application

 
Install the Expo client app on your iOS or Android phone and connect to the same wireless network as your computer. On Android, use the Expo app to scan the QR code from your terminal to open your project. On iOS, follow on-screen instructions to get a link.

@@ -139,21 +139,23 @@
 
Congratulations! You've successfully run and modified your first React Native app.

 

 
Now what?

+
Expo also has docs you can reference if you have questions specific to the tool. You can also ask for help at Expo forums.

+
If you have a problem with Expo, before creating a new issue, please see if there's an existing issue about it:

 
    
-
  • Create React Native App also has a user guide you can reference if you have questions specific to the tool.
    • 
-
  • If you can't get this to work, see the Troubleshooting section in the README for Create React Native App.
    • 
+
  • in the Expo CLI issues (for issues related to Expo CLI), or
    • 
+
  • in the Expo issues (for issues about the Expo client or SDK).
    • 
 

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

 
Running your app on a simulator or virtual device

-
Create React Native App makes it really easy to run your React Native app on a physical device without setting up a development environment. If you want to run your app on the iOS Simulator or an Android Virtual Device, please refer to the instructions for building projects with native code to learn how to install Xcode and set up your Android development environment.

+
Expo CLI makes it really easy to run your React Native app on a physical device without setting up a development environment. If you want to run your app on the iOS Simulator or an Android Virtual Device, please refer to the instructions for building projects with native code to learn how to install Xcode and set up your Android development environment.

 
Once you've set these up, you can launch your app on an Android Virtual Device by running npm run android, or on the iOS Simulator by running npm run ios (macOS only).

 
Caveats

-
Because you don't build any native code when using Create React Native App to create a project, it's not possible to include custom native modules beyond the React Native APIs and components that are available in the Expo client app.

-
If you know that you'll eventually need to include your own native code, Create React Native App is still a good way to get started. In that case you'll just need to "eject" eventually to create your own native builds. If you do eject, the "Building Projects with Native Code" instructions will be required to continue working on your project.

-
Create React Native App configures your project to use the most recent React Native version that is supported by the Expo client app. The Expo client app usually gains support for a given React Native version about a week after the React Native version is released as stable. You can check this document to find out what versions are supported.

-
If you're integrating React Native into an existing project, you'll want to skip Create React Native App and go directly to setting up the native build environment. Select "Building Projects with Native Code" above for instructions on configuring a native build environment for React Native.

+
Because you don't build any native code when using Expo to create a project, it's not possible to include custom native modules beyond the React Native APIs and components that are available in the Expo client app.

+
If you know that you'll eventually need to include your own native code, Expo is still a good way to get started. In that case you'll just need to "eject" eventually to create your own native builds. If you do eject, the "Building Projects with Native Code" instructions will be required to continue working on your project.

+
Expo CLI configures your project to use the most recent React Native version that is supported by the Expo client app. The Expo client app usually gains support for a given React Native version about a week after the React Native version is released as stable. You can check this document to find out what versions are supported.

+
If you're integrating React Native into an existing project, you'll want to skip Expo CLI and go directly to setting up the native build environment. Select "Building Projects with Native Code" above for instructions on configuring a native build environment for React Native.

 

-
Follow these instructions if you need to build native code in your project. For example, if you are integrating React Native into an existing application, or if you "ejected" from Create React Native App, you'll need this section.

+
Follow these instructions if you need to build native code in your project. For example, if you are integrating React Native into an existing application, or if you "ejected" from Expo/a> or Create React Native App, you'll need this section.

 
The instructions are a bit different depending on your development operating system, and whether you want to start developing for iOS or Android. If you want to develop for both iOS and Android, that's fine - you just have to pick one to start with, since the setup is a bit different.

 

   Development OS:
@@ -166,7 +168,7 @@
 

 

 
Unsupported

-
A Mac is required to build projects with native code for iOS. You can follow the Quick Start to learn how to build your app using Create React Native App instead.

+
A Mac is required to build projects with native code for iOS. You can follow the Quick Start to learn how to build your app using Expo instead.

 

 
Installing dependencies

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

@@ -335,7 +337,7 @@
 
Use the React Native command line interface to generate a new React Native project called "AwesomeProject":

 
react-native init AwesomeProject
 

-
This is not necessary if you are integrating React Native into an existing application, if you "ejected" from Create React Native App, or if you're adding iOS support to an existing React Native project (see Platform Specific Code).

+
This is not necessary if you are integrating React Native into an existing application, if you "ejected" from Expo (or Create React Native App), or if you're adding iOS support to an existing React Native project (see Platform Specific Code).

 

 
Creating a new application

 
Use the React Native command line interface to generate a new React Native project called "AwesomeProject":