Build tools

Learn how to use included npm scripts to compile source code, run tests, and more.

Tooling setup

Our package.json includes convenient methods for working with the framework, including compiling code, and more.

To use our build system you will have to install following components in your environment.

  1. Node.js: https://nodejs.org/en/
  2. npm: https://npmjs.com
  3. Gulp: http://gulpjs.com

Installing Node.js and updating npm

Installing Node.js

If you’re using OS X or Windows, the best way to install Node.js is to use one of the installers from the Node.js download page. If you’re using Linux, you can use the installer, or you can check NodeSource’s binary distributions to see whether or not there’s a more recent version that works with your system.

Test:

node -v

The version should be higher than v8.0.0.

Updating npm

Node comes with npm installed so you should have a version of npm. However, npm gets updated more frequently than Node does, so you’ll want to make sure it’s the latest version.

npm install [email protected] -g

Test:

npm -v

Installing project dependencies

npm install

Using NPM scripts

Our package.json includes the following commands and tasks:

Task Description
npm run build It creates the /dist directory with compiled files. Uses Sass, [Autoprefixer][autoprefixer], and UglifyJS.
npm run serve It will start a mini-server and provide a URL to view your site.

Run npm run to see all the npm scripts.

Troubleshooting

Should you encounter problems with installing dependencies, uninstall all previous dependency versions (global and local). Then, rerun npm install.