react-native-windows

React Native for the Universal Windows Platform (UWP)

This is the repository for React Native for UWP. This directory contains the following:

• ReactNative - The implementation of React Native for UWP
• ReactNative.Tests - The unit tests for React Native, currently using MSTest
• Playground - A playground for testing React Native features

Requirements

• Visual Studio 2015: Community and all other editions supported
• Windows 10 SDK: Download the latests
• Node.js v5.10.1+
• NPM v3+
• Python 2.7: Download the latest edition
• Git Client - For example:
  • GitHub Desktop for Windows
  • Git for Windows

Supported Operating Systems

This setup has only been tested on the following:

• Windows 10 November update
• Windows 10 Mobile November update
• Xbox One

Installation

First, clone the repository to your local machine which should default to the ReactWindows branch:

git clone https://github.com/ReactWindows/react-native.git
cd react-native

Next, install the NPM dependencies. Note that this will not work using MSYS such as the Git Bash, so launch a regular command prompt if you do not have Git in your PATH environment variable. This will cause a failure for installing fsevents which is not supported on Windows. If you have Git installed in your PATH environment variable and use the command prompt, then it will work properly. If you are using the Git Bash, it may error on installing fsevents, so use the regular command prompt instead.

npm install

Note that fsevents will not install as it is not compatible with Windows.

Setting Up the Build Environment

• Open up ReactNative.sln in Visual Studio 2015.
• If this is your first time using UWP, you will have to install the SDK. Right click on the solution file in the solution explorer and select the option labeled "Install Missing Components". You may have to shutdown Visual Studio to continue the installation.
• Build the solution once all the packages are installed Build => Rebuild Solution.

Running the Playground

In order to run the Playground, you must start the React Native environment by launching the following at the command prompt:

node local-cli\cli.js start

Then you can Run and Deploy as above when you built the solution. By default, the Playground will run the UIExplorer App which can be found in Examples/UIExplorer/UIExplorerApp.windows. This allows you to test out each feature of React Native as they are added for UWP.

Running the Unit Tests

To run the unit tests, do the following:

• Open up the Test Explorer Tests->Windows->Test Explorer, then select Run All.

Contributing

If you wish to contribute, we have help wanted tags in our issue tracker which contains items that are open pull requests, first come, first serve. In order to contribute, you must sign the Microsoft CLA before we can accept your commits.