Generator-tiy-webapp NPM

Yeoman TIY Generator

This is a simple Yeoman generator based off the Gulp Generator. It has been made specifically for students at The Iron Yard and is used as an introduction to Yeoman & Gulp. It includes a specific set of tools that we use throughout our course and purposefully omits certain ones until we need them.

What it Includes

Gulp
HTML Template
jQuery
Normalize
Mocha/Chai

What is Optional

Sass
Bourbon & Neat
Underscore

Installation & Usage

To install:

npm install -g generator-tiy-webapp

To update:

npm update -g generator-tiy-webapp

Check Current Version - Current Version

npm list -g  generator-tiy-webapp

This is used like any other Yeoman generator. Simply navigate to your new project folder and run:

yo tiy-webapp

Gulp Tasks

There are a few specific tasks so feel free to check out the gulpfile.js but the four most used ones will be.

gulp - This will run the default and build your dist folder
gulp watch - Starts a server and watches for changes, also livereload
gulp test-server - Starts a server instance to view your Mocha tests in the browser

Deploying Your App

By default the /dist folder is now ignored by git, so if you want to push this to Github Pages, you will need to remove that from the .gitignore file. Once you do that, the command below will work properly.