Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 1.79 KB

install.md

File metadata and controls

70 lines (44 loc) · 1.79 KB

Install

tl;dr: Download the repo and run $ npm install --global gulp && npm install in that directory to get started.

You will need to:

  1. Get a copy of the code.
  2. Install the dependencies if you don't already have them.
  3. Read the structure.md file to know where to find the files.
  4. Modify the application for your project.
  5. Run the code.
  6. Enjoy!

Getting the code

Download.

Prerequisites

Node.js

Bring up a terminal and type node --version. Node should respond with a version at or above 0.10.x. If you require Node, go to nodejs.org and click on the big green Install button.

Gulp

Bring up a terminal and type gulp --version. If Gulp is installed it should return a version number at or above 3.9.x.

CLI version 3.9.0
Local version 3.9.0

This project uses ES2015 so it is mandatory to get this Gulp version. If you need to install/upgrade Gulp, open up a terminal and type in the following:

$ npm install --global gulp

This will install Gulp globally. Depending on your user account, you may need to configure your system to install packages globally without administrative privileges.

Grunt

Bring up a terminal and type grunt --version. If Grunt CLI is installed it should return a version number at or above 0.1.x. If not, run:

npm install -g grunt-cli

Local dependencies

Next, install the local dependencies required:

$ npm install

That's it!

You may also want to get used to some of the commands available.