Development

Repository Statues

Code Styling and Conventions

• Auto-formatters and Linters
  • eslint Documentation
    • See .eslintrc
  • Prettier Documentation
    • See .prettierrc
• Documentation Generation
  • JSDoc Documentation
    • See jsdoc.json

Configurations

Development Environment

OSX

• Install Homebrew
  • Homebrew installation documentation
  • Command(s)
    • /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
• Update Homebrew
  • Command(s)
    • brew update
• Install node
  • Command(s)
    • brew install node
• Install yarn
  • Yarn installation documentation
  • Command(s)
    • brew install yarn
• Install Docker
  • Docker for Mac installation documentation
  • Command(s)
    • See 'Docker for Mac installation documentation'
• Install Codeship's JET CLI
  • Codeship JET CLI installation documentation
  • Command(s)
    • brew cask install codeship/taps/jet

Repository Environment

OSX

• Install JavaScript dependencies
  • Command(s)
    • From the root of the repository
    • yarn

Testing

Test Coverage

The SDK team has decided to use stubby as a functional testing resource in lieu of making redundant unit tests.

Local Testing

Local With - Ad-Hoc Functional Testing

To create a local stubby environment for testing

• yarn start:stubserver
  • This spins up a local stubby server
• yarn test
  • This will run the tests
• yarn stop:stubserver
  • This will terminate the stubby server

Local Testing - Run the Full Suite of Tests

• Go to https://app.codeship.com/projects/283657/configure
• Download AES key from the codeship project
  • Save it as codeship.aes
• Place the AES key in the root directory
• From the root directory enter jet steps

Documentation

Enter the command yarn apidocs to automatically generate the documentation.