Skip to content
This repository

Ultra-fast HTML5 build tool

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Brunch

HTML5 applications made easy.

Brunch is an assembler for HTML5 applications. It's agnostic to frameworks, libraries, programming, stylesheet & templating languages and backend technology.

To simplify app development, brunch watches your files for changes and automatically wraps your scripts and templates in common.js modules. All build errors are printed to console. If you have growl / libnotify, brunch will use them too.

It's like LiveReload or CodeKit plus Grunt, but much more faster, robust and universal.

Getting started

You'll need node.js 0.6.10+. Type:

npm install -g brunch

You're done!

To create a new project, execute brunch new <project name>.

To build it, execute brunch build in project directory.

To continuously rebuild the project on every change, run brunch watch.

To run a simple http server, execute brunch watch --server.

Contributing

build status

You can install the latest master version of brunch by following these simple steps:

  • Clone the repo, navigate to its directory.
  • Change bin/brunch in package.json to bin/brunchcoffee. It will allow you not to compile the source every time you change it.
  • Execute npm install to install packages.
  • Execute npm uninstall -g brunch && npm link
  • Change package.json bin/brunchcoffee back to bin/brunch.
  • Use git pull to update to latest brunch.

Test suite can be run via npm test.

Contact

License

Brunch is released under the MIT License (see LICENSE for details).

Something went wrong with that request. Please try again.