rnb-setup v1.0.0
Features
But wait... there's more!
- The best test setup: Automatically guarantee code quality and non-breaking changes. (Seen a react-native app with 100% test coverage before?)
- Stay fast: Profile your app's performance from the comfort of your command line!
There’s also a fantastic video on how to structure your React apps with scalability in mind. It provides rationale for the majority of boilerplate's design decisions.
Keywords: React.js, React-Native, Redux, Hot Reloading, ESNext, Babel, react-navigation, redux-saga, IOS, Android
Quick start
Make sure that you have Node.js v8.15.1 and npm v5 or above installed.
Make sure the development environment is configured properly.
- Clone this repo using the following command:
git clone --depth=1 https://github.com/iethem/react-native-boilerplate.git <YOUR_PROJECT_NAME>
- Move to the appropriate directory:
cd <YOUR_PROJECT_NAME>
- In order to rename the application (optional):
npm run rename "Travel App"
See details for renaming the app.
- Run
npm run setup
in order to install dependencies and clean the git repo. At this point you can run the following commands to see the example app:For <b>IOS</b>: ```command npx pod-install # to install pod dependencies npm run ios # to run the iOS application ``` For <b>Android</b>: ```command # Make sure the ANDROID_HOME environment variable is configured properly npm run android # to run the Android application ``` Start the server: ```command npm start ```
- Run
npm run clean
to delete the example app.
Now you're ready to rumble!
Please note that this boilerplate is production-ready and not meant for beginners! If you're just starting out with react or redux, please refer to https://github.com/petehunt/react-howto instead. If you want a solid, battle-tested base to build your next product upon and have some experience with react, this is the perfect start for you.
Documentation
:warning: WORK IN PROGRESS
- The Hitchhiker's Guide to
react-native-boilerplate
: An introduction for newcomers to this boilerplate. - Overview: A short overview of the included tools
- Commands: Getting the most out of this boilerplate
- Testing: How to work with the built-in test harness
- Your app: Supercharging your app with Navigating, Redux, simple asynchronicity helpers, etc.
- Troubleshooting: Solutions to common problems faced by developers.
Examples
Contributors
Thanks to you all the react-boilerplate contributors!
Contributions of any kind welcome!
License
This project is licensed under the MIT license, Copyright (c) 2019 İbrahim Ethem Topçu. For more information see LICENSE.
4 years ago