generator-webstarter

Yeoman Web Starter generator

A Yeoman generator that allows you to customize your boilerplate.

---

• Introduction
• Dependencies
• Installation
  • Alternative installation methods
    • From github
• Usage
  • Correction
• TODO

Dependencies

This generator relies on :

• Node.js
• Node Package Manager
• Yo : npm install yo

Introduction

No more need to copy-paste folders from an old project, no more need to go on Boostrap or jQuery to fetch the sources...

This generator allows you to customize your web project boilerplate. Choose what you need, and let it prepare your files.

Installation

Until it is avaible on npm, please follow the alternative installation method

Alternative installation method

Clone this repository:

git clone git://github.com/sylzys/generator-webstarter.git

or download it manually

Download as a zip, then unzip it.

Then go into the generator directory, and link it with npm

cd generator-webstarter
npm link

After that, you can use the generator by typing

yo webstarter

Usage

Generation

Just type

yo webstarter

and answer questions.

You can choose a front-end framework among :

• Twitter Boostrap
• Zurb Foundation

The files will be fetched automatically by Bower, in YOUR_FOLDER/bower_components. Don't forget to include these files (CSS, JS) in the corresponding YOUR_FOLDER/src directory, or to adjust the task runner's files accordingly.

You can also choose to use a task runner:

• Gulp
• Grunt

Optional: If you choose to use a task runner, you have the option to select several tasks, in addtition to default tasks (build, watch) :

• Javascript linting
• Javascript minification
• Javascript concatenation
• SASS Conversion to CSS
• CSS minification
• Image optimization
• more to come...

Once you selected everything you need, let the genrator fetch all dependencies for you, then ENJOY CODING

Todo

• Add test tasks (mocha...)
• Add livereload task
• Add serve/open tasks