/ChainReactApp2018

The Chain React 2018 Conference App

Primary LanguageTypeScript

ChainReactApp2018

⬆️ How to Setup

Step 1: git clone this repo:

Step 2: cd to the cloned repo:

Step 3: Install the Application with yarn

Step 4: Install Pods: cd ios && pod install. You might need to install Cocoapods if you don't already have it!

▶️ How to Run App

  1. cd to the repo
  2. Run Build for either OS
  • for iOS
    • run react-native run-ios
  • for Android
    • run react-native run-android
    • NOTE: This app uses VR software which does not run on Android emulators, so you will need to have a physical Android device connected to run the application

🚫 TSLint Compliant

This project adheres to TSLint and Prettier. We suggest you enable linting to keep your project compliant during development. You can lint the project by running yarn lint.

To Lint on Commit

This is implemented using husky. There is no additional setup needed.

Bypass Lint

If you have to bypass lint for a special commit that you will come back and clean (pushing something to a branch etc.) then you can bypass git hooks with adding --no-verify to your commit command.

Understanding Linting Errors

The linting rules are from tslint-config-prettier. Regular TS errors can be found with descriptions here.