|
| 1 | +--- |
| 2 | +id: version-0.76-getting-started |
| 3 | +title: Get Started with Windows |
| 4 | +original_id: getting-started |
| 5 | +--- |
| 6 | + |
| 7 | +This guide will help you get started on setting up your very first React Native for Windows app. |
| 8 | + |
| 9 | +Make sure you have installed all of the [development dependencies](rnw-dependencies.md). |
| 10 | + |
| 11 | +For information around how to set up React Native, see the [React Native Getting Started Guide](https://reactnative.dev/docs/getting-started). |
| 12 | + |
| 13 | +> **Interested in migrating to [React Native's New Architecture](https://reactnative.dev/architecture/landing-page)?** New Architecture support in React Native for Windows is now available to preview in 0.76. Note there are several key changes, so if you’d like to be an early adopter, check out the information in the [New Architecture Guide](new-architecture.md). |
| 14 | +
|
| 15 | +## Create a new React Native project |
| 16 | + |
| 17 | +Remember to call `@react-native-community/cli init` from the place you want your project directory to live. |
| 18 | + |
| 19 | +<!-- Note, make sure both `@react-native-community/cli@ABC` and `--version "XYZ"` are pointing to the correct NPM tags in the command below. --> |
| 20 | + |
| 21 | +<!-- 1. For the next version (i.e. in docs/getting-started.md) use "next" for the CLI and "nightly" for the RN version --> |
| 22 | +<!-- 2. For the latest stable version in versioned_docs use "latest" for both the CLI and RN version --> |
| 23 | +<!-- 3. For older stable versions you'll have to look up the CLI version, but for the RN version use the stable tag name, i.e. "0.73-stable" --> |
| 24 | + |
| 25 | +<!-- See https://www.npmjs.com/package/@react-native-community/cli?activeTab=versions for the CLI version tags. --> |
| 26 | +<!-- See https://www.npmjs.com/package/react-native?activeTab=versions for the RN version tags. --> |
| 27 | + |
| 28 | +```bat |
| 29 | +npx --yes @react-native-community/cli@latest init <projectName> --version "latest" |
| 30 | +``` |
| 31 | + |
| 32 | +### Navigate into this newly created directory |
| 33 | + |
| 34 | +React Native will have created your project in a new sub-directory, which you must enter before continuing. |
| 35 | + |
| 36 | +```bat |
| 37 | +cd <projectName> |
| 38 | +``` |
| 39 | + |
| 40 | +### Add React Native Windows to your project's dependencies |
| 41 | + |
| 42 | +<!-- Note, make sure "version" is pointing to the correct react-native-windows NPM tag in the command below. --> |
| 43 | + |
| 44 | +<!-- 1. For the next version (i.e. in docs/getting-started.md) use "canary" --> |
| 45 | +<!-- 2. For other versions in versioned_docs use the version in the format "^0.XY.0" --> |
| 46 | + |
| 47 | +<!--DOCUSAURUS_CODE_TABS--> |
| 48 | + |
| 49 | +<!--Using Yarn (Recommended)--> |
| 50 | + |
| 51 | +```bat |
| 52 | +yarn add react-native-windows@^0.76.0 |
| 53 | +``` |
| 54 | + |
| 55 | +<!--Using NPM--> |
| 56 | + |
| 57 | +```bat |
| 58 | +npm install --save react-native-windows@^0.76.0 |
| 59 | +``` |
| 60 | + |
| 61 | +<!--END_DOCUSAURUS_CODE_TABS--> |
| 62 | + |
| 63 | +### Initialize the React Native Windows native code and projects |
| 64 | + |
| 65 | +Lastly, initialize the React Native for Windows application with the [init-windows command](init-windows-cli.md): |
| 66 | + |
| 67 | +```bat |
| 68 | +npx react-native init-windows --overwrite |
| 69 | +``` |
| 70 | + |
| 71 | +> **Note:** RNW templates contain a customized `metro.config.js` file, which is meant to merge cleanly into the default config provided by the standard React Native project template. If you are starting a new app, overwriting `metro.config.js` should have no impact. However, if you are adding Windows to an existing app with an already modified `metro.config.js` file, please make sure to back up and re-apply your modifications after adding RNW. |
| 72 | +
|
| 73 | +## Running a React Native Windows App |
| 74 | + |
| 75 | +> Make sure a browser is launched and running before running a React Native Windows app. |
| 76 | +> Also ensure your system meets all the [requirements](rnw-dependencies.md) to build a Windows app as well. |
| 77 | +
|
| 78 | +- Without Using Visual Studio |
| 79 | + |
| 80 | + In your React Native Windows project directory, run the [run-windows command](run-windows-cli.md): |
| 81 | + |
| 82 | + ```bat |
| 83 | + npx react-native run-windows |
| 84 | + ``` |
| 85 | + |
| 86 | + A new Command Prompt window will open with the React packager as well as your React Native for Windows app. This step may take a while during first run since it involves building the entire project and all dependencies. You can now start developing! :tada: |
| 87 | + |
| 88 | +- Using Visual Studio |
| 89 | + |
| 90 | + - From the root of the project directory, run the [autolink-windows command](autolink-windows-cli.md), which will automatically link your app's dependencies: |
| 91 | + ```bat |
| 92 | + npx react-native autolink-windows |
| 93 | + ``` |
| 94 | + - Open the solution file in the application folder in Visual Studio (e.g., `AwesomeProject/windows/AwesomeProject.sln` if you used `AwesomeProject` as `<projectName>`) |
| 95 | + - 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. |
| 96 | + - Run `yarn start` (or `npm start`) from your project directory, and wait for the React Native packager to report success. |
| 97 | + - Click the `Run` button to the right of the platform combo box control in VS, or select the `Debug`->`Start without Debugging` menu item. You now see your new app and Chrome should have loaded `http://localhost:8081/debugger-ui/` in a new tab. Press `F12` or `Ctrl+Shift+I` in Chrome to open its Developer Tools. :tada: |
| 98 | +
|
| 99 | +- With VS Code |
| 100 | + - Open your applications folder in VS Code. |
| 101 | + - Install the [React Native Tools](https://marketplace.visualstudio.com/items?itemName=msjsdiag.vscode-react-native) plugin for VS Code. |
| 102 | + - Create a new file in the applications root directory, `.vscode/launch.json` and paste the following configuration: |
| 103 | + ```json |
| 104 | + { |
| 105 | + "version": "0.2.0", |
| 106 | + "configurations": [ |
| 107 | + { |
| 108 | + "name": "Debug Windows", |
| 109 | + "cwd": "${workspaceFolder}", |
| 110 | + "type": "reactnative", |
| 111 | + "request": "launch", |
| 112 | + "platform": "windows" |
| 113 | + } |
| 114 | + ] |
| 115 | + } |
| 116 | + ``` |
| 117 | + - Press `F5` or navigate to the debug menu (alternatively press `Ctrl+Shift+D`) and in the Debug drop-down select "Debug Windows" and press the green arrow to run the application. |
| 118 | + |
| 119 | +## Authoring Native Modules |
| 120 | + |
| 121 | +See [Native Modules and React Native Windows](native-modules.md). |
| 122 | + |
| 123 | +## Building a standalone React Native Windows App |
| 124 | + |
| 125 | +Follow these steps to build a version of your app that you can install or publish to the store. This version will package your bundle and assets into the APPX package so you don't need to run Metro. |
| 126 | + |
| 127 | +- Open the solution in Visual Studio |
| 128 | +- Select the Release configuration from the Configuration Manager drop-down. |
| 129 | +- Build the solution. You can now launch without first launching Metro. |
| 130 | +- If you want to build an APPX package to share or publish, use the **Project** > **Publish** > **Create App Packages...** option. |
| 131 | + |
| 132 | +> The Debug configuration uses the Web Debugger by default, which means the application's JavaScript code runs in Chrome.<br> |
| 133 | +> If you're getting different runtime behavior between the Release and Debug configurations, consider disabling the `UseWebDebugger` setting in [`App.cpp`](https://github.com/microsoft/react-native-windows/blob/6b415659aa017dbc41e3f28e817fb768a8e80435/vnext/template/cpp-app/src/App.cpp#L30) or [`App.xaml.cs`](https://github.com/microsoft/react-native-windows/blob/6b415659aa017dbc41e3f28e817fb768a8e80435/vnext/template/cs-app/src/App.xaml.cs#L20) to get the same behavior in the Debug configuration. |
| 134 | +
|
| 135 | +See also this article for additional details: https://techcommunity.microsoft.com/t5/windows-dev-appconsult/getting-started-with-react-native-for-windows/ba-p/912093# |
| 136 | + |
0 commit comments