Note: this file is over 50 lines long because it contains a lot of relevant information in one place.

Code Standards

• all code is in TypeScript, using .tsx for files containing jsx, or .ts for those without
• no semicolons
• 2 spaces
• newline at end of file (check your editor settings)
• trim whitespace on save (check your editor settings)
• keep code in appropriate packages under packages/<package>
• discuss with team before adding a new package
• only use third-party libraries when absolutely required
• no hardcoded text in the app, belongs in packages/language/<language>
• no style outside of packages/theme/default (we may add themes later)
• for the most part, files should be called index.ts with any dependencies in ./lib/<function-name>.ts
• all snake-case directory names and file names, leads to less issues
• code under ui should generally begin with import React, { Component } from 'react' to avoid linter errors for React
• ui components generally look like export default class ComponentName extends Component<Props, State>

Packages

Note: to import from a package see .babelrc and tsconfig.json for package name rewrites. Important: no relative imports starting with ../ - in other words never assume what's above you in the file tree - you must be able to move folders around without consequence.

Note: TypeScript code is compiled into lib top level directory.

• credit-protocol contains the client library to connect to BlockMason's credit-protocol server.

  • i.e. import { CreditProtocolClient } from 'credit-protocol'

• language contains all text strings and functions used to generate text.

  • i.e. import language from 'language'; const { privacyPolicy, pendingTransactionsLanguage } = language

• lndr/* is the core application logic and should have zero references to react or any other ui.

  • i.e. import LNDR from 'lndr'

• theme/* contains all stylesheets.

  • i.e. import style from 'theme/button'

• ui/* is the react-native user interface.

  • i.e. import App from 'ui/app'

Running

Installation and Initialization

Copy, rename, and update the files android/app/src/main/assets/airshipconfig.properties.example and ios/AirshipConfig.plist.example with the proper UrbanAirship API key and secret from the Blockmason account on urbanairship.com

Log in to Firebase (https://console.firebase.google.com/u/0/project/lndr-english/settings/general/android:com.lndr) and download the google-services.json and GoogleService-Info.plist files and add them to the android and ios folders.

• Ensure that CocoaPods and Yarn are both installed (sudo gem install cocoapods and brew install yarn)
• yarn (this installs the packages)
• Fill in the .env.example with the proper information and save as .env. (info is in airshipconfig.properties or AirshipConfig.plist)
• yarn run setup:env
• (in new terminal) yarn run typescript
• (in new terminal) yarn start

... on iOS

• Put GoogleService-Info.plist in ios/

• Put AirshipConfig.plist in ios/

• Put PayPalConfig.plist in ios/

• Run cd ios && pod install && cd ..

• react-native run-ios

... on Android

Setting up ANDROID_HOME env variable

export ANDROID_HOME=/<SDK installation location> export PATH=${PATH}:$ANDROID_HOME/tools:$ANDROID_HOME/platform-tools source ~/.bash_profile