Rabbiteer 2016

This project is was a skeleton for a typical NodeJS application. Now it's been expanded to be an Express hosted Angular single page application.

This project contains a whole bunch of things you can work on for the Rabbiteer program :)

Prerequisites

1. Node

Installation

1. git clone https://github.com/RetroRabbit/rabbiteer-2016.git
2. Navigate into folder and run npm install
3. Start the site by running npm start (Or just press F5 in VS Code).

What is included

• Code linter - eslint
• Test runner - mocha
• Test coverage checker - istanbul
• Task manager - gulp
• Pre-commit hook
• JsDoc generation - jsdoc
• ES6 Support(ECMA-262, Edition 5) - babel
• Codeclimate integration codeclimate
• TravisCI integration travis-ci
• Editor Config editorconfig
• List all available tasks using gulp help npm run command
• Javascript intellisense using Typings
• Express hosting Angular single page application
• Sass Stylesheets downcompiling to css
• Clientside javascript using Browserify
• Dev support including watches for css and js, and LiveReload for rapid dev

Linting

npm run lint

Code that will be validated:

• all *.js files in src folder
• all *.js files in test folder
• all *.js files in www folder
• gulpfile.js

Running tests and generating code coverage report

npm run coverage

Test cases stored in files test/**/*.spec.js will be run only

Coverage reports will be generated and stored in folder build/coverage

Generating jsdoc

npm run jsdoc

Documentation will be generated for *.js files from src folder and stored in folder build/jsdoc

Compiling code - ES6 Support

Since nodejs doesn't fully support all ES6 features source code should be compiled.

npm run build

Source code in src folder will be compiled and stored in folder build/source

Running all tasks

gulp
# or
gulp build

Pre-commit hook

This hook is invoked by git commit, and can be bypassed with --no-verify option.

The task gulp build will be run automatically.

Printing all available tasks and theirs arguments

npm run