Learn how to included npm scripts to automate your time-consuming tasks in your development workflow with Gulp toolkit.

Quick Start

Coach uses NPM scripts for its build system. Our package.json includes convenient methods for working with the framework, including compiling code, running tests, and more.

To use our build system and run our documentation locally, you'll need a copy of Coach's source files and Node. Follow these steps and you should be ready to rock:

  1. Download and install Node.js , which we use to manage our dependencies.
  2. Download and install Gulp.js , which we use to manage our dependencies.
  3. Navigate to the root /coach directory and run npm install to install our local dependencies listed in package.json.

When completed, you'll be able to run the various commands provided from the command line.

Installing Gulp.js

Please note, first Gulp should be installed globally and for that reason -g command is used.

npm install gulp-cli -g

Installing NPM modules

First, change the command line path into your project where Coach folder is located. if you have not done this before, you may check the following article to quick start, you may run package.json file by using the following command:

npm install

If you check the project folder when the command has finished executing, you should see that Gulp has created a node_modules folder.

Run Gulp

Compile and watch the SCSS/JS/HTML, use Live Reload to update browsers instantly, start a server, and pop a tab in your default browser. Any changes made to the source files will be compiled as soon as you save the file. To try it out run:


Generates a /dist directory with all the production files.

gulp build