We are no longer using this boilerplate. We have developed another one, which has amazing features. Check it out. SimformRN

Basic React-Native Boiler Plate

This is a very basic boilerplate of react-native. It will be very helpful to kick-start your project, because it provides some common tools you may need. They are as following:
- ES6 based project architecture
- react-navigation: A very helpful and easily customizable navigation libray.
- react-native-extended-stylesheet: Every mobile application should be responsive even if we don't use flex-layout for all the styling in the application. Instead of using the StyleSheet provided by react-native, we recommend using the stylesheet provided by this library.
- native-base: A very rich UI library which is also customizable. By using it, you don't have to create some basic UI components in your application. Further more it also provides react-native-vector-icons out of the box.
- "eslint:recommended" linting guide: Writing good and error free code is a must. eslint will help you to write good code and not to make common mistakes.
- There are pre-commit hooks implemented to prevent bad commits. So if you don't lint your code before commititng it, you won't be able to commit it.

⬆️ How to Setup

Step 1: git clone this repo.

Step 2: cd to the cloned repo.

Step 3: Rename the project bundleId, package name and application name.

Step 4: Install the npm modules required for the project with npm i

▶️ How to Run App

cd to the repo
Run Build for either OS

for iOS
- run npm run ios
for Android
- run npm run android

Eslint Compliant

This project adheres to "eslint:recommended" style guide. We have setup and enabled eslint for this project. We suggest that you keep following it.

To Lint

This is implemented using eslint. Just run npm run lint

To Fix Lint Errors

run npm run fixcode

Bypass Lint And Run Project

If you have to bypass lint and just run the project for special case.

for iOS
- run react-native run-ios
for Android
- run react-native run-android

Understanding Linting Errors

The linting rules are from eslint and React-Standard. Regular JS errors can be found with descriptions here, while React errors and descriptions can be found here. We have customised the linting as per our requirements. You can check the .eslintrc of the project and modify it as per your requirements.

🔐 Secrets

This project uses react-native-config to expose config variables to your javascript code in React Native. You can store API keys and other sensitive information in a .env file:

API_URL=https://myapi.com
GOOGLE_MAPS_API_KEY=abcdefgh

and access them from React Native like so:

import Secrets from 'react-native-config'

Secrets.API_URL  // 'https://myapi.com'
Secrets.GOOGLE_MAPS_API_KEY  // 'abcdefgh'

The .env file is ignored by git keeping those secrets out of your repo.

Get started with react-native-config:

Copy .env.example to .env
Add your config variables
Follow instructions at https://github.com/luggit/react-native-config#setup
Done!