# Swill Boilerplate Generator

[![Build Status](https://travis-ci.org/tiagoporto/generator-swill-boilerplate.svg)](https://travis-ci.org/tiagoporto/generator-swill-boilerplate)
[![Coverage Status](https://img.shields.io/coveralls/tiagoporto/generator-swill-boilerplate.svg)](https://coveralls.io/github/tiagoporto/generator-swill-boilerplate)
[![NPM version](https://badge.fury.io/js/generator-swill-boilerplate.svg)](https://npmjs.org/package/generator-swill-boilerplate)
[![NPM Downloads](https://img.shields.io/npm/dt/generator-swill-boilerplate.svg)](https://www.npmjs.com/package/generator-swill-boilerplate)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)
[![Github License](https://img.shields.io/github/license/tiagoporto/generator-swill-boilerplate.svg)](https://raw.githubusercontent.com/tiagoporto/generator-swill-boilerplate/master/LICENSE)

<small>Generator Dependencies:</small>
[![Dependencies Status](https://david-dm.org/tiagoporto/generator-swill-boilerplate.svg)](https://david-dm.org/tiagoporto/generator-swill-boilerplate)
 [![devDependencies Status](https://david-dm.org/tiagoporto/generator-swill-boilerplate/dev-status.svg)](https://david-dm.org/tiagoporto/generator-swill-boilerplate?type=dev)

<small>Swill Boilerplate Dependencies:</small>
[![boilerplate devDependencies Status](https://david-dm.org/tiagoporto/swillboilerplate.rocks/dev-status.svg)](https://david-dm.org/tiagoporto/swillboilerplate.rocks?type=dev)

<p align="right">
  <img src="http://icons.iconarchive.com/icons/icons8/christmas-flat-color/256/star-icon.png" alt="Star" height="25"><img src="http://icons.iconarchive.com/icons/icons8/christmas-flat-color/256/star-icon.png" alt="Star" height="25"><img src="http://icons.iconarchive.com/icons/icons8/christmas-flat-color/256/star-icon.png" alt="Star" height="25"><br>
  <code>LIKE ? Leave a <a href="https://github.com/tiagoporto/generator-swill-boilerplate/tree/master">Star</a> : Make a DEV sad</code>
</p>

<p align="center">
  <img src="http://tiagoporto.github.io/swillboilerplate.rocks/img/logos/logo.png" alt="Swill Boilerplate Logo">
  <img src="https://nerdsondotcom.files.wordpress.com/2013/03/yeoman-logo.png" alt="Yeoman Logo" height="215">
</p>

> Yeoman generator for [Swill Boilerplate](http://swillboilerplate.rocks)


## Features

* Cleans the assets (build, images, CSS, JS) in the project to maintain the directory organization
* Compresses Images
* Generates Sprites with .png
* Generates Sprites with .svg and a .png to fallback
* Analyzes CSS with CSS Lint
* Prefixes CSS with Autoprefixer
* Compiles Sass or Stylus (Catches Stylus errors and shows them directly on the page, as in Sass)
* Combines matching media queries into one
* Concatenates and minifies scripts
* Analyzes JavaScript with ESLint
* Compiles ES2015, ES2016 and ES2017
* Validates HTML
* Notifies when tasks are complete
* Monitors changes in the files and reloads the browser with BrowserSync
* Uses Jasmine & Karma to test JavaScript
* Builds the project compressing HTML, CSS and JS
* Pushes the `build` folder to gh-pages branch
* Uses [http://standardjs.com/](JavaScript Standard Style)

## Installation

First, install [Yeoman](http://yeoman.io) and `generator-swill-boilerplate` using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-swill-boilerplate
```

Then generate your new project:

```bash
yo swill-boilerplate
```


## Docs

[Swill Boilerplate](http://swillboilerplate.rocks)

## License

Swill Boilerplate Generator is released under the terms of the [MIT license](https://github.com/tiagoporto/generator-swill-boilerplate/blob/master/LICENSE).