node package manager

adfab-gulp-boilerplate

Adfab's boilerplate. Helps you kick-start a front-end project within minutes.

Adfab Gulp Boilerplate

The goal of this Gulp boilerplate is to free you time so you can do something more interesting than reinventing the wheel, it includes:

  • Automatic reloading of the browser on code modification (using Browsersync)
  • CSS / JS Sourcemaps
  • HTML minification
  • JS compilation
  • Babel transpiler (ES6 support FTW)
  • SASS or LESS compilation
  • Notifications on success and error
  • Fonticon generation
  • Production mode: JS / CSS minification + sources maps removal

Installation

npm install git+ssh://git@github.com:AdFabConnect/adfab-gulp-boilerplate.git#v0.9.2

Upon installation, two files will be copied to the root of your project: gulpfile.js and gulp-config.js.

Usage

Enable the tasks you need

Just check gulpfile.js out de-comment what you need and comment out what you don't.

Configure the tasks

Every task rely on the gulp-config.js file for their configuration. Just fill-in the values you need.

Browser live reloads

Start Browsersync:

gulp serve

It acts as a proxy to the domain you specified in gulp-config.js (property vhost). You can now access your project by specifying the 3000 port (if you usually access your project via http://project.localhost/, now it would be http://project.localhost:3000/).

You can also test it in production mode by passing the --production option. That way, it will remove sourcemaps and minify JS and CSS.

ISC License

Copyright 2017 Adfab

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.