React Native Boilerplate

React Native Boilerplate is a starting point for React Native application.

Features

• Redux
• React Navigation (with drawer)
• Jest
• NativeBase (UI Kit)
• CircleCI
• Eslint (Airbnb config)

Prerequisites

• Node v6.10 (it is recommended to install it via NVM)
• Yarn
• A development machine set up for React Native by following these instructions

Getting Started

1. Clone this repo, git clone [email protected]:novom/react-native-boilerplate.git <your project name>
2. Go to project's root directory, cd <your project name>
3. Remove .git folder, rm -rf .git
4. Open package.json and change the name property with your project name
5. Run yarn to install dependencies
6. Run react-native upgrade to update the project name to android and ios build

• Type y to each prompt

8. Run rm -rf android/app/src/main/java/com/reactnativeboilerplate
9. Run rm -rf ios/ReactNativeBoilerplate
10. Run react-native link
11. Open src/app/App.js and replace 'ReactNativeBoilerplate' by your project name
12. Copy settings/development.sample.json to settings/development.json and adapt its contents to your needs
13. Open environment.json and set the desired execution environment
14. Start the packager with yarn start
15. Connect a mobile device to your development machine
16. Run the test application:

• On Android:
  • Run react-native run-android
• On iOS:
  • Open ios/VillageQuebecoisAntan.xcodeproj in Xcode
  • Hit Run after selecting the desired device

17. Have fun!

How To

Run Tests

• Linter: yarn lint
• Unit tests: yarn test
• Unit tests (watch mode): yarn test:watch
• Code coverage: yarn test:coverage

Contributing

Never commit directly on master, instead use branches and pull requests.

You must use the following Style Guides :

• Airbnb React/JSX Style Guide
• Airbnb JavaScript Style Guide

This project contains a linting config, you should setup eslint into your IDE with .eslintrc.js.