Skip to content

Latest commit

 

History

History
45 lines (33 loc) · 877 Bytes

File metadata and controls

45 lines (33 loc) · 877 Bytes

Development Manual

DISCUSS, CLONE, DEVELOP, COMMIT, PROFIT

Tools

Structure

  • doc: generated API documentation based on the JSDoc in the sources
  • src: project's sources compartmentalized as modules.
  • task: organized Gulp tasks
  • test: several, per-module tests

Main NPM commands

# Checks coding style
npm run check

# Runs all tests with coverage checks
npm run test

# Generates the documentation in doc/API.md
npm run doc

# Prepares (check-and-test) the project before committing 
npm run prepare

HAVE FUN!