README.md

Start your next react native project in seconds

A highly scalable, offline-first foundation with the best DX and a focus on performance and best practices

_{Created by Kerem Çubuk and maintained with ❤️ by an amazing idea reinforced with react-boilerplate.}

Website: reactnativeboilerplate.dev

Motivation:

While creating this project, I always need to a react-native standart for our team. When we start to new project, we always spend too much time. So that, we created react-native-boilerplate and we wanted to share with the community.

Features

Quick scaffolding

Create components, containers, routes, selectors and sagas - and their tests - right from the CLI!

Instant feedback

Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the CSS and JS are reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!

Predictable state management

Unidirectional data flow allows for change logging and time travel debugging.

Next generation JavaScript

Use template strings, object destructuring, arrow functions, JSX syntax and more.

Industry-standard routing

It's natural to want to add pages (e.g. `/about`) to your application, and routing makes this possible.

Industry-standard i18n internationalization support

Scalable apps need to support multiple languages, easily add and support multiple languages with `react-intl`.

Static code analysis

Focus on writing new features without worrying about formatting or code quality. With the right editor setup, your code will automatically be formatted and linted as you work.

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?)
• The fastest fonts: Say goodbye to vacant text.
• Stay fast: Profile your app's performance from the comfort of your command line!

_{Keywords: React Native, React.js, Redux, Fast Refresh, ESNext, Babel, react-navigation, Offline First, ServiceWorker, redux-saga}

Quick start

1. Clone repository

git clone --depth=1 https://github.com/keremcubuk/react-native-boilerplate.git <YOUR_PROJECT_NAME>

2. Move to the appropriate directory:

cd <YOUR_PROJECT_NAME>

3. Rename the project:

npx react-native-rename <YOUR_PROJECT_NAME>

Note: Before npm install

4. Android and iOS runnning is different. So that follow the steps below.

IOS:

npx pod-install # to install pod dependencies
npm run ios     # to run the iOS application

Android:

# Make sure the ANDROID_HOME environment variable is configured properly

npm run android # to run the Android application

Start the server:

npm start

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

• 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 Routing, Redux, simple asynchronicity helpers, etc.
• Troubleshooting: Solutions to common problems faced by developers.

Contributors

Contributions of any kind welcome!

License

This project is licensed under the MIT license, Copyright (c) 2020 Kerem Çubuk. For more information see LICENSE.md.