Skip to content

Commit 7914402

Browse files
committed
added instructions for running on the master branch
1 parent b545267 commit 7914402

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -767,6 +767,31 @@ firestack.off('listenForAuth');
767767

768768
Firestack provides a built-in way to connect your Redux app using the `FirestackModule` export from Firestack.
769769

770+
## Running with the `master` branch
771+
772+
Most of our work is committed to the master branch. If you want to run the bleeding-edge version of Firestack, you'll need to follow these instructions.
773+
774+
Since `react-native` doesn't like symlinks, we need to clone the raw repository into our `node_modules/` manually. First, in order to tell `react-native` we are using the package `react-native-firestack`, make sure to install the `npm` version:
775+
776+
```bash
777+
npm install --save react-native-firestack
778+
```
779+
780+
After the `npm` version is installed, you can either clone the repo directly into our `node_modules/` directory:
781+
782+
```bash
783+
git clone https://github.com/fullstackreact/react-native-firestack.git ./node_modules/react-native-firestack
784+
```
785+
786+
Alternatively, you can clone the repo somewhere else and `rsync` the directory over to the `node_modules/` directory.
787+
788+
> This is the method I use as it allows me to separate the codebases:
789+
790+
```bash
791+
git clone https://github.com/fullstackreact/react-native-firestack.git ~/Development/react-native/mine/react-native-firestack/
792+
## And rsync
793+
rsync -avhW --delete --exclude='node_modules' --exclude='.git' --exclude='*.desktop.js' ~/Development/react-native/mine/react-native-firestack/ ./node_modules/react-native-firestack/
794+
```
770795

771796
## Contributing
772797

0 commit comments

Comments
 (0)