Skip to content

Commit e60428d

Browse files
sayarmatthargett
authored andcommitted
chore(documentation): Update documentation for VS 2017. (microsoft#1307)
* chore(documentation): Update documentation for VS 2017. Closes microsoft#1290. * chore(documentation): Marking Visual Studio 2015 as deprecated.
1 parent a93ddc9 commit e60428d

File tree

2 files changed

+89
-88
lines changed

2 files changed

+89
-88
lines changed

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ See the official [React Native website](https://facebook.github.io/react-native/
2727

2828
## System Requirements
2929

30-
- You can build and deploy React Native Windows apps on the Pro or Enterprise versions of Windows 7 SP1, Windows 8.1, or Windows 10
30+
- You can build and deploy React Native Windows apps on the Pro or Enterprise versions of Windows 7 SP1, Windows 8.1, or Windows 10
3131
- *Note:* You cannot run the emulators and some other developer tooling on the "Starter" or "Home" versions of these operating systems
3232
- You can run React Native Windows UWP apps only on Windows 10 devices, but React Native Windows WPF apps will run on Windows 7-10 so long as .NET 4.6 is installed on the end user's machine
33-
- Download [Visual Studio 2015 Community](https://www.visualstudio.com/vs/older-downloads/)
33+
- Download [Visual Studio 2017 Community or Greater](https://www.visualstudio.com/downloads/). (Visual Studio 2015 support is being deprecated.)
3434
- - You will need to start Visual Studio after it is installed to do some final setup before it can be used to build or run your React Native Windows application
3535
- [Windows 10 SDK Build 14393](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive)
3636

37-
*Note*: Development on React Native Windows itself currently requires Visual Studio 2015. It is not supported with Visual Studio 2017 or with VS Code, but we will gladly accept pull requests to enable a great developer experience in those environments.
37+
*Note*: Development on React Native Windows itself currently requires Visual Studio 2017. It is not supported with VS Code, but we will gladly accept pull requests to enable a great developer experience in those environments.
3838

3939
## Getting Started
4040

@@ -43,9 +43,10 @@ See the official [React Native website](https://facebook.github.io/react-native/
4343
- Install [rnpm-plugin-windows](https://www.npmjs.com/package/rnpm-plugin-windows) from NPM (i.e., `npm install --save-dev rnpm-plugin-windows` or `yarn add rnpm-plugin-windows --dev` if you have Yarn installed).
4444
- Initialize Windows project with `react-native windows` command in the project directory.
4545
- *Note*: You will need to install the [requirements](#system-requirements) before you can build and run your application.
46-
- Open the solution file in the application folder in Visual Studio (e.g., `AwesomeProject/windows/AwesomeProject.sln`)
46+
- Open the solution file in the application folder in Visual Studio (e.g., `AwesomeProject/windows/AwesomeProject.sln`)
4747
- *Note*: If this is your first time doing UWP development on the computer you're using, you may be asked to install additional UWP tooling. After opening the solution, right click the Solution in the Solution Explorer and select the option labeled "Install Missing Components". You may have to shutdown Visual Studio to continue the installation.
48-
- Select the "Debug" configuration and the "x64" platform from the combo box controls to the left of the Run button and underneath the Team and Tools menu item.
48+
- *Note*: If you are using Visual Studio 2017, you will need to retarget the ChakraBridge project by right clicking on the project in the Solution Explorer and selecting "Retarget Projects" and pressing okay on the popup dialog (Platform Toolset should say "Upgrade to v141" in the dialog).
49+
- Select the "Debug" configuration and the "x64" platform from the combo box controls to the left of the Run button and underneath the Team and Tools menu item.
4950
- *Note:* If you are running on, or targeting, an x86 platform select "x86" instead. If you are deploying to Windows 10 Phone, select ARM.
5051
- Click the Run button to the right of the platform combo box control, or select the "Debug"->"Start without Debugging" menu item.
5152
- You should now see a typical React Native app running on Windows that is showing an error saying it needs to contact the dev server. Almost there!
@@ -112,7 +113,7 @@ Each pull request has the unit tests, code analysis, and a [Winium](https://gith
112113

113114
- If you're looking for sample code, just browse the RNTester folder in the GitHub web UI
114115
- From your recursive clone of the react-native-windows repo, run ``git pull --recurse-submodules`` to make sure you're up to date with latest code
115-
- Start the React Native packager by running `react-native start`
116+
- Start the React Native packager by running `react-native start`
116117
- Open RNTester.sln from the RNTester submodule folder in Visual Studio.
117118
- Set the StartUp project to the example you want to run, press F5.
118119

docs/RunningOnDeviceWindows.md

+82-82
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,82 @@
1-
---
2-
id: running-on-device-windows
3-
title: Running On Device
4-
layout: docs
5-
category: Guides (Windows)
6-
permalink: docs/running-on-device-windows.html
7-
---
8-
9-
## Running the Universal Windows App with react-native-cli
10-
11-
You can deploy your react-native-windows app to the Desktop using the [react-native-cli](http://npmjs.com/packages/react-native-cli):
12-
```
13-
react-native run-windows
14-
```
15-
For more information on the kinds of options and flags available for deploying to devices and emulators, use the `--help` flag to get the command usage information.
16-
17-
## Running the Universal Windows App with Visual Studio
18-
19-
Open your solution in Visual Studio 2015, follow the instructions below for the device family you want to deploy to, and press F5. Visual Studio will pull in the NuGet dependencies, build, deploy, and launch the application.
20-
21-
### Desktop
22-
23-
Set the Platform build target to something compatible with your host OS, and choose the Local Machine deployment target.
24-
25-
![Deploy Local Machine](img/DeployLocalMachine.png)
26-
27-
### Mobile Emulator
28-
29-
Set the Platform build target to something compatible with your host OS, and choose the Mobile Emulator you wish to deploy to.
30-
31-
You may have to install the Windows 10 Mobile emulators for Visual Studio. Instructions are [here](https://msdn.microsoft.com/en-us/windows/uwp/debug-test-perf/test-with-the-emulator). You may also have to enable Hyper-V on your machine, instructions are [here](https://msdn.microsoft.com/library/windows/apps/xaml/jj863509.aspx).
32-
33-
![Deploy Mobile Emulator](img/DeployMobileEmulator.png)
34-
35-
### Device
36-
37-
Set the Platform build target to something compatible with your device OS (typically ARM), and choose the Device deployment target.
38-
39-
![Deploy Device](img/DeployDevice.png)
40-
41-
_Note:_ If you haven't already, you'll also need to enable Developer Mode on your device under Settings, Update & security, For developers, Developer Mode.
42-
43-
_Note:_ If you see `Unexpected Error: -1988945906`, check that the `Windows Phone IP over USB Transport (IpOverUsbSvc)` service is listed and running in the Services app. If the IpOverUsbSvc is not running follow the instructions listed in the forum response to [this question](https://social.msdn.microsoft.com/Forums/windowsapps/en-US/74fafd96-50cf-4d77-9d7a-41620c5487a5/uwpsdkipoverusbsvc-service-missing-in-windows-10-rc-build-10240?forum=wpdevelop) .
44-
45-
### Xbox
46-
47-
Assuming you have already [enabled Developer Mode on your Xbox](https://msdn.microsoft.com/en-us/windows/uwp/xbox-apps/devkit-activation), deploying to Xbox is easy, just follow the instructions to set up your development environment for Remote Machine deployment [here](https://msdn.microsoft.com/en-us/windows/uwp/xbox-apps/development-environment-setup).
48-
49-
![Deploy Remote Machine](img/DeployRemoteMachine.png)
50-
51-
## Accessing development server from device
52-
53-
If you are running the Universal Windows app on a device or Xbox, you'll need to configure the IP address of the `DevSupportManager` to match your machine's IP address.
54-
55-
We're working on creating a settings page to manage the debug server host address, but for now you can statically configure it in [`DevServerHelper`](https://github.com/Microsoft/react-native-windows/blob/master/ReactWindows/ReactNative.Shared/DevSupport/DevServerHelper.cs#L22)
56-
57-
## Using offline bundle
58-
59-
If you generated your project using `rnpm-plugin-windows`, the solution is already set up with two Configurations for running from an offline bundle, `DebugBundle` and `ReleaseBundle`.
60-
61-
![Bundle Configuration](img/ConfigurationBundle.png)
62-
63-
Before deploying with this configuration, you'll have to generate the `index.windows.bundle` file with the following command:
64-
65-
```
66-
react-native bundle --platform windows --entry-file index.windows.js
67-
--bundle-output windows\myapp\ReactAssets\index.windows.bundle
68-
--assets-dest windows\myapp\ReactAssets
69-
```
70-
71-
To generate the release (minified) bundle, add the `--dev false`:
72-
73-
```
74-
react-native bundle --platform windows --entry-file index.windows.js
75-
--bundle-output windows\myapp\ReactAssets\index.windows.bundle
76-
--assets-dest windows\myapp\ReactAssets
77-
--dev false
78-
```
79-
80-
Be sure to update the paths to match the path to your ReactAssets folder.
81-
82-
To create an app package and upload your app to the Windows store, [follow these instructions](https://docs.microsoft.com/en-us/windows/uwp/packaging/packaging-uwp-apps#create-an-app-package).
1+
---
2+
id: running-on-device-windows
3+
title: Running On Device
4+
layout: docs
5+
category: Guides (Windows)
6+
permalink: docs/running-on-device-windows.html
7+
---
8+
9+
## Running the Universal Windows App with react-native-cli
10+
11+
You can deploy your react-native-windows app to the Desktop using the [react-native-cli](http://npmjs.com/packages/react-native-cli):
12+
```
13+
react-native run-windows
14+
```
15+
For more information on the kinds of options and flags available for deploying to devices and emulators, use the `--help` flag to get the command usage information.
16+
17+
## Running the Universal Windows App with Visual Studio
18+
19+
Open your solution in Visual Studio, follow the instructions below for the device family you want to deploy to, and press F5. Visual Studio will pull in the NuGet dependencies, build, deploy, and launch the application.
20+
21+
### Desktop
22+
23+
Set the Platform build target to something compatible with your host OS, and choose the Local Machine deployment target.
24+
25+
![Deploy Local Machine](img/DeployLocalMachine.png)
26+
27+
### Mobile Emulator
28+
29+
Set the Platform build target to something compatible with your host OS, and choose the Mobile Emulator you wish to deploy to.
30+
31+
You may have to install the Windows 10 Mobile emulators for Visual Studio. Instructions are [here](https://msdn.microsoft.com/en-us/windows/uwp/debug-test-perf/test-with-the-emulator). You may also have to enable Hyper-V on your machine, instructions are [here](https://msdn.microsoft.com/library/windows/apps/xaml/jj863509.aspx).
32+
33+
![Deploy Mobile Emulator](img/DeployMobileEmulator.png)
34+
35+
### Device
36+
37+
Set the Platform build target to something compatible with your device OS (typically ARM), and choose the Device deployment target.
38+
39+
![Deploy Device](img/DeployDevice.png)
40+
41+
_Note:_ If you haven't already, you'll also need to enable Developer Mode on your device under Settings, Update & security, For developers, Developer Mode.
42+
43+
_Note:_ If you see `Unexpected Error: -1988945906`, check that the `Windows Phone IP over USB Transport (IpOverUsbSvc)` service is listed and running in the Services app. If the IpOverUsbSvc is not running follow the instructions listed in the forum response to [this question](https://social.msdn.microsoft.com/Forums/windowsapps/en-US/74fafd96-50cf-4d77-9d7a-41620c5487a5/uwpsdkipoverusbsvc-service-missing-in-windows-10-rc-build-10240?forum=wpdevelop) .
44+
45+
### Xbox
46+
47+
Assuming you have already [enabled Developer Mode on your Xbox](https://msdn.microsoft.com/en-us/windows/uwp/xbox-apps/devkit-activation), deploying to Xbox is easy, just follow the instructions to set up your development environment for Remote Machine deployment [here](https://msdn.microsoft.com/en-us/windows/uwp/xbox-apps/development-environment-setup).
48+
49+
![Deploy Remote Machine](img/DeployRemoteMachine.png)
50+
51+
## Accessing development server from device
52+
53+
If you are running the Universal Windows app on a device or Xbox, you'll need to configure the IP address of the `DevSupportManager` to match your machine's IP address.
54+
55+
We're working on creating a settings page to manage the debug server host address, but for now you can statically configure it in [`DevServerHelper`](https://github.com/Microsoft/react-native-windows/blob/master/ReactWindows/ReactNative.Shared/DevSupport/DevServerHelper.cs#L22)
56+
57+
## Using offline bundle
58+
59+
If you generated your project using `rnpm-plugin-windows`, the solution is already set up with two Configurations for running from an offline bundle, `DebugBundle` and `ReleaseBundle`.
60+
61+
![Bundle Configuration](img/ConfigurationBundle.png)
62+
63+
Before deploying with this configuration, you'll have to generate the `index.windows.bundle` file with the following command:
64+
65+
```
66+
react-native bundle --platform windows --entry-file index.windows.js
67+
--bundle-output windows\myapp\ReactAssets\index.windows.bundle
68+
--assets-dest windows\myapp\ReactAssets
69+
```
70+
71+
To generate the release (minified) bundle, add the `--dev false`:
72+
73+
```
74+
react-native bundle --platform windows --entry-file index.windows.js
75+
--bundle-output windows\myapp\ReactAssets\index.windows.bundle
76+
--assets-dest windows\myapp\ReactAssets
77+
--dev false
78+
```
79+
80+
Be sure to update the paths to match the path to your ReactAssets folder.
81+
82+
To create an app package and upload your app to the Windows store, [follow these instructions](https://docs.microsoft.com/en-us/windows/uwp/packaging/packaging-uwp-apps#create-an-app-package).

0 commit comments

Comments
 (0)