Skip to content

Latest commit

 

History

History
executable file
·
46 lines (27 loc) · 1.96 KB

README.md

File metadata and controls

executable file
·
46 lines (27 loc) · 1.96 KB

KNI Boilerplate


For jump-starting new HTML projects.

Technologies / Dependencies

  • Gulp – Gulp is our task runner of choice, and is responsible for all minification, concatination, and watch tasks for dev.
  • Stylus – Stylus provides extremely fast, expressive, powerful, and robust pre-processing for our CSS.
  • Axis – Axis is a sizeable css utility library built on top of stylus and and nib.
  • Jeet – More than a grid system. Makes layout a a breeze.
  • Rupture – Stylus media query utility for gorgeous breakpoints

Getting Started

The first dependency you will need is Brew. Brew is a package manager for OSX and will allow us to install, and update Node through the command line. In your Terminal window run the following command:

ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"

After that is completed, run:

brew doctor

This will tell you if there is anything in your system preventing Brew from doing it's job. Typically there won't be any major problems reported, but go ahead and fix any major blocking issues reported before moving on.

Next up run the following command to get NodeJS and NPM (Node Package Manager) installed -- this may require sudo:

brew install node

Assuming this worked, you now have NodeJS installed. While the boilerplate isn't run on a node server, we love to take advantage of it's Node Package Manager!

Installation Instructions

  1. Clone this repository
  2. Run: npm install

Usage

Run: gulp watch

This will compile all of the necessary images, CSS, and Javascript, run watch tasks to compile the aforementioned files when edited, and spin up a live-reload server.

Browser Support

IE 9 + the good ones

v.1.0