@elliemae/encw-loan-parser

Docs

http://githubdev.dco.elmae/pages/elliemae/encw-loan-parser/

Coverage

http://githubdev.dco.elmae/pages/elliemae/encw-loan-parser/lcov

Project Structure

• TODO: Document project structure

Developer Setup

• Install git for your OS

  • If you are on mac, launch Terminal.app and type command git --version. This will prompt you to install git if you don’t have it installed already.
  • For other OS and other installation methods for Mac, follow official install method

• Install Node.js for your OS

  • If you are on Mac, NVM is preferred installation method.
  • If you are on Mac, but prefer Mac Package Managers (Homebrew, MacPorts or pkgsrc), use Native installation method.
  • If you are on Windows, follow the default .msi install method

• Once you have git and node.js installed, clone this repo to your local machine using git clone command:

  git clone http://githubdev.dco.elmae/Elliemae/encw-loan-parser.git

• After cloning this repo locally, just run setup command:

  cd encw-loan-parser
  npm run setup

• To run parser locally, run start command:

  npm start

  This will watch the source code and compile it for consumption in encompass-web

• To load code in encompass-web, run `npm link' command:

  cd encompass-web
  npm link ../../<path-to-encw-loan-parser>

Publish to NPM

• run npm run pub command in project root.

Editor Setup

• If you are using Visual Studio Code, add below extensions for better coding experience:

  • Prettier

• If you are using WebStorm, add below plugins for better coding experience:

  • Prettier

Git Hooks Setup

• This repository uses Prettier. Prettier is an opinionated code formatter with support for JavaScript (including ES2017), JSX, Flow, TypeScript, CSS, Less, SCSS, JSON, GraphQL, Markdown (including GFM). It removes all original styling* and ensures that all outputted code conforms to a consistent style.
• We use Prettier with a pre-commit tool. This re-formats your files that are marked as "staged" via git add before you commit. More documentation for such setup is available at Prettier Website