react-native-config/windows/README.md

Expose config variables to React Native apps

# react-native-config Windows Implementation

## Module Installation
You can either use autolinking on react-native-windows 0.63 and later or manually link the module on earlier realeases.

### Automatic install with autolinking on RNW >= 0.63
RNCConfig supports autolinking. Just call: `npm i react-native-config --save`

### Manual installation on RNW >= 0.62
1. `npm install react-native-config --save`
2. Open your solution in Visual Studio 2019 (eg. `windows\yourapp.sln`)
3. Right-click Solution icon in Solution Explorer > Add > Existing Project...
4. Add `node_modules\react-native-config\windows\RNCConfig\RNCConfig.vcxproj`
5. Right-click main application project > Add > Reference...
6. Select `RNCConfig` in Solution Projects
7. In app `pch.h` add `#include "winrt/RNCConfig.h"`
8. In `App.cpp` add `PackageProviders().Append(winrt::RNCConfig::ReactPackageProvider());` before `InitializeComponent();`

### Manual installation on RNW 0.61
Do the same steps as for 0.62, but use `node_modules\RNCConfig\windows\RNCConfig61\RNCConfig.vcxproj` in step 4.

## Module development

If you want to contribute to this module Windows implementation, first you must install the [Windows Development Dependencies](https://microsoft.github.io/react-native-windows/docs/rnw-dependencies).

You must temporary install `react-native-windows` package. Versions of `react-native-windows` and `react-native` must match. E.g. if the moudule uses `react-native@0.62`, install `npm i react-native-windows@^0.62 --dev`.

Now, you will be able to open corresponding `RNCConfig...sln` file, e.g. `RNCConfig62.sln` for `react-native-windows@0.62`.