indigo-app

• Standard compliant React Native App Utilizing Ignite

⬆️ How to Setup

Step 1: git clone this repo:

Step 2: cd to the cloned repo:

Step 3: Install the Application with yarn or npm i

▶️ How to Run or Build App

1. Install Node v8 LTS, if you do not have it. https://nodejs.org/
2. Make sure you have NPM v5.5+. If you do not have it, after installing Node, npm install -g npm@latest.
3. Use Android Studio to install Android SDKs. Android SDK v23 (Marshmallow) is required. Install the x86/x86_64 images for emulator. You should also install Android SDK Tools and Android SDK Platform-Tools.
4. Install node modules and and run all required modules for Indigo POS:
   • npm install
   • npm run android to run the app using connected hardware or emulator.
   • npm run android:build to build the app for release. The release APK can be found under android/app/build/outputs/apk.

🚫 Standard Compliant

This project adheres to Standard. Our CI enforces this, so we suggest you enable linting to keep your project compliant during development.

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 JS Standard and React-Standard. Regular JS errors can be found with descriptions here, while React errors and descriptions can be found here.

🔐 Secrets

This project uses react-native-config to expose config variables to your javascript code in React Native. You can store API keys and other sensitive information in a .env file:

API_URL=https://myapi.com
GOOGLE_MAPS_API_KEY=abcdefgh

and access them from React Native like so:

import Secrets from 'react-native-config'

Secrets.API_URL  // 'https://myapi.com'
Secrets.GOOGLE_MAPS_API_KEY  // 'abcdefgh'

The .env file is ignored by git keeping those secrets out of your repo.