Skip to content

Latest commit

 

History

History
187 lines (139 loc) · 12 KB

README.md

File metadata and controls

187 lines (139 loc) · 12 KB
Raw
Logo

Release Date Version TypeScript Support Dark Theme Setup Firebase Code-Push Integrated Push Notificaxtions Redux Offline Storage Splash Screen Multilingual Support Maintained

React-Native-Boilerplate

This project is a React Native boilerplate that can be used to kickstart a mobile application.

The boilerplate provides a architecture optimized for developing reliable cross-platform mobile applications through the separation of concerns between the UI and business logic. It is remarkably documented so that each section of code that lands in your application can be understood and used.

If you find this boilerplate useful then please give the repository a star

Architecture

The main purpose of the Architecture of the boilerplate is the separation of concerns

  • Presentational components are separated from screens.

  • State is managed using global Redux stores.

  • Application side-effects (API calls, etc.) are separated from UI and state manipulation using Redux Saga.

Content

The boilerplate contains:

Note: Custom Drawer and Custom Bottom Tabs are also part of the boilerplate.

Directory layout

Requirements

Node 8 or greater is required. Development for iOS requires a Mac and Xcode 9 or up and will target iOS 9 and up.

You also need to install the dependencies required by React Native:

Using the boilerplate

To create a new project using the boilerplate:

  • Clone this repository

  • Remove the previous git history: rm -rf .git/

  • Install the npm dependencies by running yarn or npm install

  • Rename the React Native project (Without custom Bundle Identifier)

    yarn run rename -- <YourProjectName> or npm run rename -- <YourProjectName> (the default name is boilerplate)

  • Rename the React Native project (With custom Bundle Identifier, Android only. For iOS, please use Xcode)

    yarn run rename -- <YourProjectName> -b <bundleIdentifier> or npm run rename -- <YourProjectName> -b <bundleIdentifier> (the default name is boilerplate)

  • Facebook SDK Android/iOS Setup

    For facebook login to work in the android app please replace FacebookAppID and FacebookLoginProtocolScheme value in the .env.staging and .env.production files present in the root directory

  • Google Sign-In SDK Android Setup

    For push notifications and google signin to work in the android app place your google-services.json into Android/app folder

  • Google Sign-In SDK iOS Setup

    For push notifications and google signin to work in the iOS app drag your GoogleService-Info.plist to project folder in the xcode and replace REVERSED_CLIENT_ID value present in the .env.staging and .env.production with REVERSED_CLIENT_ID present in the GoogleService-info.plist

  • [Optional]codepush android setup

    For code-push to work in the android app please first create app on app center for os="Android" and platform="React Native" . After creating the app you will get app secret key, insert your app_secret into android/app/src/main/assets/appcenter-config.json. Go to the Distribute side menu on the app center, click code push, and generate production and staging deployment keys. Place production deployment key into file .env.production present in the root directory against key CodePushDeploymentKey_Android and place staging deployment key into file .env.staging present in the root directory against key CodePushDeploymentKey_Android

  • [Optional]codepush ios setup

    For CodePush to work in the iOS app please first create app on app center for os="iOS" and platform="React Native" . After creating the app you will get the app secret key, insert your app_secret into AppCenter-Config.plist. Go to the Distribute side menu on the app center, click code push, and generate production and staging deployment keys. Place production deployment key into file .env.production present in the root directory against key CodePushDeploymentKey_iOS and place staging deployment key into file .env.staging present in the root directory against key CodePushDeploymentKey_iOS

You can now create a new git repository for your project (using git init) and create the first commit.

Running the project

Assuming you have all the requirements installed, you can setup and run the project by running:

  • yarn or npm install to install the dependencies
  • Run the following steps for your platform

Android

  • Only the first time you run the project, you need to generate a debug key with:
    • cd android/app
    • keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000
    • cd ../.. to come back to the root folder
  • yarn start or npm install to start the metro bundler, in a dedicated terminal
  • yarn run android:debug-release or npm run android:debug-release to run the Android application (remember to start a simulator or connect an Android phone)

iOS

  • cd ios
  • pod install to install pod dependencies
  • cd .. to come back to the root folder
  • react-native run-ios to run the iOS application (remember to start a simulator or connect an iPhone phone)

Useful documentation

CodePush

CodePush is an App Center cloud service that enables Apache Cordova and React Native developers to deploy mobile app updates directly to their users’ devices.

Google Sign-In SDK

Google Sign-In is a secure authentication system that reduces the burden of login for your users, by enabling them to sign in with their Google Account—the same account they already use with Gmail, Play, and other Google services.

Facebook SDK

The Facebook SDK for is the easiest way to integrate your app with Facebook. It enables:

  • Facebook Analytics - Understand how people are using your product.
  • Facebook Login - Authenticate people with their Facebook credentials.
  • Share and Send dialogs - Enable sharing content from your app to Facebook.
  • App Events - Log events in your application.
  • Graph API - Read and write to Graph API.

I18next

I18next is an internationalization-framework written in and for JavaScript. But it's much more than that.

i18next goes beyond just providing the standard i18n features such as (plurals, context, interpolation, format). It provides you with a complete solution to localize your product from web to mobile and desktop.

License

This project is released under the MIT License.

Why this boilerplate?

I looked into existing boilerplates before starting this project, and while many of them are awesome, But every boilerplate was lacking something, so I come up with a boilerplate that has all the features that modern app needed. For example

  • React Native Latest Stable Version (v0.63.2)
  • Great Architecture
  • React Navigation 5 Integrated
  • Redux Integrated
  • Redux Saga Integrated
  • Redux Persist Integrated
  • Firebase SDK Integrated
  • Facebook SDK Integrated
  • Google Sign-in SDK Integrated
  • Code-Push SDK Integrated
  • Push Notifications Integratd
  • Theme Integrated
  • Multilingual Integrated
  • Splash Screen Integrated
  • Vector Icons Integrated
  • TypeScript Support