SimformRN

The repository for learning and understanding about Redux-Saga.

Project Name: SagaOperations

Bundle Id: com.simform.sagaoperations Package Name: com.sagaoperations

---

Project Desctiption

A react-native boilerplate to kickstart your project with some commonly used setups, components, navigation and screens.

Prerequisites

iOS : XCode(10.2) onwards

Android : Android Studio(3.4) with gradle(5.1.1) onwards

Editor : Visual Studio Code

How to Setup Project

Step 1: Clone this repository.

Step 2: Go to the cloned repo and open in in termianl.

Step 3: Install the dependencies with $ npm i

Step 4: Run the npm script to install the cocoapods $ npm podinstall

How to Run the Project

1. Change directory to project
2. Run and build for either OS
   • Run iOS app

     npm run ios //for normal functionality
     npm run ios-search //for search functionality

   • Run Android app
     • Start Genymotion or Native emulator

     npm run android

   • Note: This npm scripts will lint your code first. If there are no lint errors, then it will run the ios or android app. Otherwise it will show the lint errors in the terminal.

Reusablity

• How it can be reused?
  • Clone the repository
  • Install react-native-rename as global
• There are two bugs with this lib though.

  • If your old project name and new project name have same strings in them, it won't rename the ios .pbxproj, .xcodeproj and .xcworkspace files.

  • To overcome this, we can rename the project with a totally different name first and than can rename it with the actual name.

    first command: <project_root_directory>$react-native-rename "TestApp" -b com.simform.testapp
  
    second command: <project_root_directory>$react-native-rename "SimformRN" -b com.simform.simformrn

Coding Style used

This project adheres to JavaScript Standard for codinng style. To maintain coding standards, utilising features of ES6 and follow best development practices of react-native, this project also uses ES6, some rules of eslint-airbnb, eslint-plugin-react and eslint-plugin-react-native.

Do not disable lint inside the code. Try to understand the rule and then follow it into your code. Disabling lint will be considered a violation of coding standards. Exceptions will be allowed by the code-reviewer and team lead after understanding the need to ignore lint.

1. To Lint

   Use the npm script lint. To run it

  npm run lint

2. Auto Lint on Commit

   This is implemented using husky. So husky will prevent code-cmmits having lint errors. There is no additional setup needed.

3. Understanding Linting Errors

   The linting rules are from JS Standard and React-Standard. Regular JS errors can be found with descriptions here, while React errors and descriptions can be found here.

Extra steps for android

Describe any extra steps which need to be taken fo the auto-generated android project. Eg. Some specific setup of any manifest file, some manual linking which is buggy and needs to be corrected for first checkout etc. Here is an example:

• Mind the version of google services used in the project. All google services must have same version. This is implemented using project level build.gradle.

Extra steps for ios

Describe any extra steps which need to be taken for the auto-generated ios project. Eg. Some specific setup of any certificates, pods, linking, information in Info.plist, some manual linking which is buggy and needs to be corrected for first checkout etc. Here is an example:

• You will need all the certificates to run the ios project in a real device.

List of all dependencies used in the project with their usage

List all dependencies from the package.json file along with their usage. This list must be updated every time you change/add any dependecy. Here are some examples:

• Framework:

  • React Native

• State management libraries:

  • Redux, React Redux, Redux Persist, Seamless-Immutable

• API & Middleware libraries:

  • API Sauce, Redux Sauce, Redux Saga

• Libraries used for navigation:

  • react-navigation, react-native-gesture-handler, react-native-reanimated, react-navigation-redux-helpers, react-navigation-stack

• Libraries used for UI:

  • native-base

Following accounts are used for the mentioned platform

Mention all the accounts used for various development and deployement platforms. Just email/username should be mentioned but never a password. Make sure this information stays in a private repository. If your repository is public, do not share this kind of private information via readme. Provide another private source. Like a private file on our zoho or a file in Microsoft Teams.

Codebeat: abc@abc.com

Bitrise: abc@abc.com

Google Play: abc@abc.com

Apple Store and developer account: abc@abc.com

Fabric: abc@abc.com

Firebase/Google service: abc@abc.com

Troubleshoot Notes

Provide troubleshoot guideline for any known issues. For example, a specific error for build proccess or deployement process or even an error in any third party dependency.

For example

• Application crashes in production because of react-native-maps. Follow this link to fix it.

If there no known issues:

• There are no known issues for run or build processes right now.

Notes

Here any information which is important but not mentioned above and must be passed among all developers, should be mentioned. Like which branch is used for build releases, library deprecations etc.

For example

• Release builds are distributed from develop-release branch and all pull requests are done to develop branch.