cfUtilityService v1.0.0

Getting Started

Clone the repo:

git clone git@github.com:KunalKapadia/cfUtilityService.git
cd cfUtilityService

Install dependencies:

npm install

Start server:

# set DEBUG env variable to get debug logs
DEBUG=cfUtilityService:* npm start
# OR
# requires gulp to be installed globally
npm i -g gulp
gulp serve

Execute tests:

# compile with babel and run tests
npm test (or gulp mocha)

# use --code-coverage-reporter text to get code coverage for each file
gulp mocha --code-coverage-reporter text

Other gulp tasks:

# Wipe out dist and coverage directory
gulp clean

# Lint code with ESLint
gulp lint

# Default task: Wipes out dist and coverage directory. Compiles using babel.
gulp

Commit:

Follows AngularJS's commit message convention

# Lint and execute tests before committing code.
npm run commit
# OR
# use git commit directly with correct message convention.
git commit -m "chore(ghooks): Add pre-commit and commit-msg ghook"

Code Coverage

Get code coverage summary on executing npm test

npm test also generates HTML code coverage report in coverage/ directory. Open lcov-report/index.html to view it.