StarwarDiaries

The repository for StarwarDiaries.

Project Name: StarwarDiaries

Project Desctiption

A react-native application to show list of vehicles used in Starwars.

Prerequisites

expo cli

Editors : Visual Studio Code/snack.expo.io

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 application dependencies with $ yarn

Step 4: Run the npm script to install the cocoapods $ yarn run pod install

How to Run the Project

Steps to run the project in ios and andorid

1. Run and build for either OS using expo cli and Mac OS
   • Go to the project directory inside the terminal.
   • Run npm script $ yarn run ios to run in iOS.
   • Run npm script $ yarn run android to run in android.

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.

1. To Lint

   Use the npm script lint. To run it

  yarn 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.

List of all dependencies used in the project with their usage

• Framework:

  • React Native

• State management libraries:

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

• API & Middleware libraries:

  • API Sauce, Redux Saga

• Libraries used for UI:

  • native-base, expo-font,

• Utilities libraries

  • lodash