jacobmfoley/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 JS > 12 and npm (Recommended: Use nvm)
• Watchman
• Xcode
• Cocoapods
• JDK > 8
• Android Studio and Android SDK

Base dependencies

• axios for networking.
• prop-types to type-check our components exposed properties.
• react-native-config to manage envionments.
• react-navigation navigation library.
• react-native-localization for string localization.
• react-native-mmkv-storage as storage solution.
• redux for state management.
• redux-persist as persistance layer.
• redux-thunk to dispatch asynchronous actions.
• jest and react-native-testing-library for testing.

Usage

Use Template button

Click the "Use this template" button above the file list, then use the Owner drop-down menu, and select the account you want to own the repository. Creating a repository from a template has the following advantages:

• A repository created from a template starts with a single commit.
• Commits to a repository created from a template do appear in your contribution graph.
• Creating a repository from a template starts a new project quickly.

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 npm run ios or npm 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 to store any common component that you use through your app (such as a generic button)
  • constants: Folder to store any kind of constant that you have.
  • controllers: Folder to store all your network logic (you should have one controller per resource).
  • localization: Folder to store the languages files.
  • navigation: Folder to store the navigators.
  • reducers: This folder should have all your reducers, and expose the combined result using its index.js
  • screens: Folder that contains all your application screens/features.
    • Screen: Each screen should be stored inside it's own folder, and inside it a file for its code and a separate one for the styles and tests. Then, the index.js is only used to export the final component that will be used on the app.
      • Screen.js
      • Screen.styles.js
      • Screen.test.js
      • index.js
  • selectors: Folder to store your selectors for each reducer.
  • storage: Folder that contains the application storage logic.
  • store: Folder to put all redux middlewares and the store.
  • theme: Folder to store all the styling concerns related to the application theme.
  • App.js: Main component that starts your whole app.
• index.js: Entry point of your application as per React-Native standards.

Splash screen customization

To customize the splash screen (logo and background color) use the CLI provided in the official docs.

Setup environments

Add the environment variables files in root folder(.env.staging and .env.production)

Android

A map associating builds with env files is already defined in app/build.gradle you can modify or add environments if needed.

For multiple enviroments to work you would need to change -keep class [YOUR_PACKAGE_NAME].BuildConfig { *; } on proguard-rules.pro file.

iOS

The basic idea in iOS is to have one scheme per environment file, so you can easily alternate between them.

Start by creating a new scheme:

• In the Xcode menu, go to Product > Scheme > Edit Scheme
• Click Duplicate Scheme on the bottom
• Give it a proper name on the top left. For instance: "Production"
• Then edit the newly created scheme to make it use a different env file. From the same "manage scheme" window:

Expand the "Build" settings on left

• Click "Pre-actions", and under the plus sign select "New Run Script Action"
• Where it says "Type a script or drag a script file", type: echo ".env.production" > /tmp/envfile replacing .env.production with your file

Styleguide

For coding styling we decided to go with ESLint and React Native community's styleguide.