GulpShot

A simple way to kick start gulp based web app projects.

Getting Started

First you need to install the module running:

npm install -g gulpshot

To create and start using a new gulpshot project, run the following:

# Bootstrap a new gulpshot project
$ gulpshot new my_awesome_project
$ cd my_awesome_project
# Install node dependencies...
$ npm install
# Start a new server and watch for changes
$ gulp serve

Features

• CSS Autoprefixing
• Automatically minify css files
• Automatically compile Sass
• Automatically compile CoffeeScript
• Automatically lint scripts via jsHint
• Automatically uglify script files
• Automatically optimize image files (.jpg, .png, .gif)
• Watches for changes
• Initialize a preview server with LiveReload support
• Generates an optimized build
• Bundles js modules via browserify
• SOON: Runs Mocha tests

Structure

A sample project structure would be:

|-- app
|  |-- vendors (bower_components)
|  |-- styles
|  |  |-- style_one.scss
|  |  |-- style_two.scss
|  |-- scripts
|  |  |-- script_one.coffee
|  |  |-- script_two.coffee
|  |-- images
|  |  |-- background.png
|  |-- index.html
|-- dist
|  |-- styles
|  |  |-- main.min.css
|  |-- scripts
|  |  |-- scripts.min.js
|  |-- images
|  |-- index.html
|-- node_modules
|-- test

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

License

Copyright (c) 2014 Bernardo Gurgel Filho Licensed under the MIT license.