Skip to content

Latest commit

 

History

History
54 lines (33 loc) · 1.73 KB

install.md

File metadata and controls

54 lines (33 loc) · 1.73 KB
Raw

Install

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

To take advantage of Web Starter Kit you need to:

  1. Get a copy of the code.
  2. Install the dependencies if you don't already have them.
  3. Modify the application to your liking.
  4. Deploy your production code.

Getting the code

Download and extract WSK to where you want to work.

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. 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.

Local dependencies

Next, install the local dependencies Web Starter Kit requires:

$ npm install

Note: if you have the Yarn package manager installed, you can just run yarn. Web Starter Kit includes a yarn.lock file that will be used here.

That's it! You should now have everything needed to use the Web Starter Kit.

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