Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/drgx/react-native-plus-web

React Native + Web Boilerplate
https://github.com/drgx/react-native-plus-web

boilerplate boilerplate-template haul js lerna lernajs react react-native react-native-web react-navigation react-router web webapp webpack

Last synced: 22 days ago
JSON representation

React Native + Web Boilerplate

Awesome Lists containing this project

README

        

# React Native + Web Boilerplate
Ultimate React Native + Web Boilerplate. This boilerplate is created on top of React Native and React Native Web. The idea is create project with seamless development experience and shareable codebase for both react native and react native web.
## Key Feature
1. Clear project structure & dependencies using [lerna](https://github.com/lerna/lerna).
2. React Native project support symlink and webpack ecosystem using [haul](https://github.com/callstack/haul).
3. Built-in Navigation ([react navigation](https://reactnavigation.org/) and [react-router](https://github.com/ReactTraining/react-router)).
4. Web history API support.
5. Same navigation API using [react navigation](https://reactnavigation.org/) API style.
6. Wrap some react native component that currently not implemented yet on react-native web (Modal)

## ⚑️ Get Started Immediately ⚑️
#### Clone this repository and install all dependencies
```
git clone [email protected]:drgx/react-native-plus-web.git
cd react-native-plus-web
yarn

# bootstrap all package dependencies
yarn bootstrap
```
### 🌟Preview 🌟
![preview](https://user-images.githubusercontent.com/5230095/38617965-8a827142-3dc2-11e8-9791-05dbb66006a9.gif)

### Running Apps
You need to start the server by following this commend:
```
cd packages/apps/
yarn haul
#choose to run server between Ios, Android or Both Ios and Android
```

#### For running android
Open your [android emulator](https://medium.com/@deepak.gulati/running-react-native-app-on-the-android-emulator-11bf309443eb) or plug your android devices

Simply run `react-native run-android`.

Since react-native v0.52+ to be able to start using `haul` you need to disable delta (cmd+m -> dev setting, uncheck use js deltas) and debug JS remotely on our emulator or devices. See [haul limitation & issue](https://github.com/callstack/haul#limitations). This issue is likely fix by haul team soon.

#### For running ios
Open your [ios simulator](https://facebook.github.io/react-native/docs/running-on-simulator-ios.html). Simply run `react-native run-ios` on your terminal.

#### Running Web
```
cd packages/web/
yarn watch:web
# open http://localhost:3000 on your browser
```

## Folder structure
```
react-native-plus-web
β”œβ”€β”€ README.md
β”œβ”€β”€ lerna.json
β”œβ”€β”€ package.json
└── packages
β”œβ”€β”€ apps <<<< React Native Project
β”‚Β Β  β”œβ”€β”€ android
β”‚Β Β  β”œβ”€β”€ app.json
β”‚Β Β  β”œβ”€β”€ index.js
β”‚Β Β  β”œβ”€β”€ ios
β”‚Β Β  β”œβ”€β”€ package.json
β”‚Β Β  β”œβ”€β”€ webpack.haul.js
β”‚Β Β  └── yarn.lock
β”œβ”€β”€ shared <<<< Shared code between apps and web
β”‚Β Β  β”œβ”€β”€ components
β”‚Β Β  β”‚Β Β  β”œβ”€β”€ Modal
β”‚Β Β  β”‚Β Β  └── Navigator
β”‚Β Β  β”œβ”€β”€ constants
β”‚Β Β  β”‚Β Β  └── routes.js
β”‚Β Β  β”œβ”€β”€ package-lock.json
β”‚Β Β  β”œβ”€β”€ package.json
β”‚Β Β  └── yarn.lock
└── web <<<< React Native web Project
β”œβ”€β”€ font.js
β”œβ”€β”€ index.web.js
β”œβ”€β”€ loaderConfiguration.js
β”œβ”€β”€ package.json
β”œβ”€β”€ template.html
β”œβ”€β”€ webpack.common.js
β”œβ”€β”€ webpack.dev.js
β”œβ”€β”€ webpack.prod.js
└── yarn.lock
```

## Routes & Navigation
For editing or adding new routes simply edit [`routes.js`](https://github.com/drgx/react-native-plus-web/blob/master/packages/shared/constants/routes.js)

And for moving between screen simply use `this.props.navigation` to navigate based on routes definition on [`routes.js`](https://github.com/drgx/react-native-plus-web/blob/master/packages/shared/constants/routes.js)

```
# Example to navigate to detail screen
{
this.props.navigation.navigate("Detail");
}}
/>

# Example to back
{
this.props.navigation.goBack();
}}
/>
```
## Contributing
We'd ❀️ to have your helping hand on react-native-plus-web! Feel free to PR's, add issues or give feedback! Happy Hacking!! 😎