Starter Gulp + Browserify project with examples of how to accomplish some common tasks and workflows. Read the blog post for more context, and check out the Wiki for some good background knowledge.
Includes the following tools, tasks, and workflows:
- Browserify (with browserify-shim)
- Watchify (caching version of browserify for super fast rebuilds)
- SASS (with compass and source maps!)
- CoffeeScript (with source maps!)
- jQuery (from npm)
- Backbone (from npm)
- Handlebars (as a backbone dependency)
- BrowserSync for live reloading and a static server
- Image optimization
- Error Notifications in Notification Center
- Non common-js vendor code (like a jQuery plugin)
If you've never used Node or npm before, you'll need to install Node. If you use homebrew, do:
brew install node
Otherwise, you can download and install from here.
Gulp must be installed globally in order to use the command line tools. You may need to use sudo
npm install -g gulp
Alternatively, you can run the version of gulp installed local to the project instead with
./node_modules/.bin/gulp
The gulp-compass module relies on Compass already being installed on your system.
If you have bundler installed, simply run bundle to install dependencies from the Gemfile
bundle
Otherwise,
gem install sass
gem install compass --pre
npm install
This runs through all dependencies listed in package.json
and downloads them
to a node_modules
folder in your project directory.
gulp
This will run the default
gulp task defined in gulp/tasks/default.js
, which does the following:
- Run 'watch', which has 2 task dependencies,
['setWatch', 'browserSync']
setWatch
sets a variable that tells the browserify task whether or not to use watchify.browserSync
hasbuild
as a task dependecy, so that all your assets will be processed before browserSync tries to serve them to you in the browser.build
includes the following tasks:['browserify', 'sass', 'images', 'markup']