react-native-template-everywhere
v0.3.2
Published
react-native template to target multiple platforms.
Downloads
38
Readme
re-start :globe_with_meridians: :iphone: :computer:
This project is an attempt to:
- Target multiple platforms (Android, iOS, Web, Windows[UWP] and Electron[macOS, Ubuntu, Windows]) with react native' APIs and a single codebase.
- Follow best practices while doing the above.
- Cut out the time and effort it takes to setup the project (based on create-react-app).
- Achieve 'Write once use everywhere' with react-native (though react strictly says 'Learn once use anywhere').
Current status:
What used to be react-native-everywhere before is now re-start (where re stands for react-everywhere). Good news is that react-native-cli now supports templates. So, it makes much more sense if this project is a react-native-template, which will remove the need to update this project with every major release of react-native. It just works as of now on all the platforms. So, no more git cloning.
Usage
Pre-requisites:
Node.js & npm on your system(follow this)
react-native CLI (npm install -g react-native-cli
)
All you have to do is:
- Create a new react-native project using react-native-cli and specify this project as a template:
react-native init <Your Project Name> --template everywhere --version="0.44.2"
- Since react-native-template does'nt support adding dev dependencies and custom scripts to package.json, so I have created a custom script to do that.
node scripts/addDevDependencies.js
Notes:
- If the above script fails due to some reason, you can do it manually by copying the contents of devDependencies.json to your package.json's devDependencies object and adding following to the scripts object.
"web": "node scripts/start.js",
"build": "node scripts/build.js"
- react-native-web currently (20th of July, 2017) supports React/ReactDOM 15.4, 15.5, or 15.6, so make sure you do not upgrade if you want support for web.
- make sure that the version of react-native-windows is same as your react-native version, if you are targeting windows support.
Run the project on a specific platform:
Android
react-native run-android
iOS
react-native run-ios
Web
npm/yarn run web
Windows
react-native windows
react-native run-windows
Desktop (Electron)
npm/yarn run electron
Build for production:
Android/iOS
Web
npm/yarn run build
(this will build your production ready bundle)
Some very useful cross platform compatible libraries:
- react-native-vector-icons
- re-render (this is experimental and a WIP)
- axios
- react-navigation (might be included in ReactNativeEverywhere soon)
Progress:
- [x] support for web (react-native-web)
- [x] support for Windows (react-native-windows)
- [x] Support for electron
- [ ] Compatibility with React 16
Running demo on Web, Android, iOS, Windows(Universal) and Electron:
Contributors
Thanks goes to these wonderful people (emoji key):
| Amogh Banta💻 🎨 📖 🐛 🤔 ⚠️ | Jesús Leganés-Combarro💻 🤔 🐛 ⚠️ 👀 📖 | Christopher Hein📖 🐛 | DuncanMacWeb💻 | | :---: | :---: | :---: | :---: |
Full list of contributors can be found here.
Sponsors
These are the companies contribution to re-start
's development in some way or other.
Companies and projects using re-start
If you use re-start
in any of your projects, send us a pull-request with the link. :smile:
LICENSE
MIT