cwj10 / react-native-template

A starter project for a React Native app

React-Native-Template

The goal of this project is to work as template for react-native applications, providing a base project structure, core dependencies and boilerplate to jumpstart development.

Prerequisites

• Node > 7 and npm (Recommended: Use nvm)
• Watchman brew install watchman
• React Native CLI npm install -g react-native-cli
• XCode > 9
• JDK > 8
• Android Studio and Android SDK

Base dependencies

• axios for networking.
• PropTypes to type-check our components exposed properties.
• React-Native-Config to manage envionments.
• React-Navigation navigation library.
• React-Native-Localization for string localization.
• Redux for state management.
• Redux-Persist as persistance layer.
• Redux-Thunk to dispatch asynchronous actions.
• Reselect the selector library for redux.
• Jest and Enzyme for testing.

Usage

Option #1: Using React-Native-Rename

You can start by cloning this repository and using react-native-rename. In the current state of this project, it should give you no issues at all, just run the script, delete your node modules and reinstall them and you should be good to go.

Keep in mind that this library can cause trouble if you are renaming a project that uses Pods on the iOS side.

After that you should proceed as with any javascript project:

• Go to your project's root folder and run npm install.
• Create a .env file to store all your configuration constants. Remember to not commit this file, since it can store sensible information of your product.
• Run react-native run-ios or react-native run-android to start your application!

Option #2: Copy the structure to your project

If you want to roll on your own and don't want to use this as a template, you can create your own project and then copy the /src folder (which has all the code of your application) and update your index.js.

Keep in mind that if you do this, you'll have to install and link all dependencies (as well as adding all the necessary native code for each library that requires it).

Folder structure

This template follows a very simple project structure:

• src: This folder is the main container of all the code inside your application.
  • actions: This folder contains all actions that can be dispatched to redux.
  • assets: Asset folder to store all images, vectors, etc.
  • components: Folder that contains all your application components.
    • Common: Folder to store any common component that you use through your app (such as a generic button, textfields, etc).
    • MyComponent: Each component should be stored inside it's own folder, and inside it a file for its code and a separate one for the styles. Then, the index.js is only used to export the final component that will be used on the app.
      • MyComponent.js
      • styles.js
      • index.js
  • helpers: Folder to store any kind of helper that you have.
  • reducers: This folder should have all your reducers, and expose the combined result using its index.js
  • selectors: Folder to store your selectors for each reducer.
  • controllers: Folder to store all your network and storage logic (you should have one controller per resource).
  • App.js: Main component that starts your whole app.
• index.js: Entry point of your application as per React-Native standards.

Styleguide

For coding styling we decided to go with ESLint and Airbnb's styleguide with a few exceptions that you can find on the .eslintrc.json

Useful resources & Further reading

This are some posts/guides that explain some things that we use inside the project:

• React-Native-Navigation and Redux.

For further explaining on the decisions made on this template, as well as on how to use it, please refer to the full tutorial