Will you be coming to brunch?

Brunch...

People love Brunch!

Brunch is an ultra-fast HTML5 build tool

Installation is one-line, once you have node.js. In your console, run:

npm install -g brunch

Getting started

Create a new Brunch project:

brunch new <skeleton-URL> [optional-output-dir]

skeleton-URL specifies a skeleton from which your application will be initialized.

See the README for a complete description of app structure.

Develop with Brunch:

brunch watch --server

tells Brunch to watch your project and incrementally rebuild it when source files are changed. The optional server flag launches a simple web server with pushState support.

If you use OS X and want brunch to show system notification every time compilation error happens, you will need to install terminal-notifier: brew install terminal-notifier.

Build with Brunch:

brunch build --production

builds a project for distribution. By default it enables minification.

Documentation

All docs are available on GitHub.

A Quick Demo

For more info on getting started with Brunch, see the article or the introductory video and screencast:

Deploying

Brunch-generated applications are a bunch of simple static files. You can host them everywhere, even on free hostings, like GitHub pages. Because production environments are usually slightly different than development envs, brunch has production option.

To build application that has minified JS and CSS, execute brunch build --production. Then you can deploy it:

  • If you use static hosting site: build your application on your machine and just upload public/ directory to the directory that is served by a webserver.
  • If you use hosting that supports node.js, you can install brunch there and auto-build app every time.
  • If you prefer Heroku, there is a nice small guide on deploying. Should work even on free instances.
  • If you’re into GitHub pages, you’ll need to build your app, move public/ directory to somewhere, switch to gh-pages git branch, remove files from directory and move files from your temporary dir here.

Brought to you by