RN

The repository for StarWars.

Product Flavors: StarWars*: com.starwars.app

Project Description

Description...

Prerequisites

iOS : XCode(12.0.1) onwards

Android : Android Studio(4.0) with gradle(6.3) onwards

Editor : Visual Studio Code

How to Setup Project

Step 1: Clone this repository.

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

Step 3: Install the dependencies with $ yarn

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

How to Run the Project

Open the project directory in to terminal
Run and build for either OS _ Run iOS app yarn ios _ Run Android app yarn 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 dependency
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.mobmaxime.testapp

  second command: <project_root_directory>$react-native-rename "mobmaximeRN" -b com.mobmaxime.mobmaximern
```

Template generator

Why generator?
- Generator will help us to save 5-15 minutes time when creating every module, screen, component, reducer, saga, service etc.

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.

To Lint

Use the yarn script lint or 'fixcode'. To run it

  yarn lint

Auto Lint on Commit

This is implemented using husky. So husky will prevent code-cmmits having lint errors. There is no additional setup needed.
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

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

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, Rematch, @react-native-community/netinfo
API & Middleware libraries:
- API Sauce
Libraries used for navigation:
- "@react-navigation/native, @react-navigation/stack, @react-native-community/masked-view, react-native-screens, react-native-gesture-handler, react-native-reanimated
Libraries used for forms and validations:
Libraries used for UI:

native-base, react-native-safe-area-context

Libraries used for storage:

Troubleshoot Notes

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

Notes

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

dharmik/StarWars

RN