Brunch

Web applications made easy. Since 2011.

Fast front-end web app build tool with simple declarative config and seamless incremental compilation for rapid development.

Usage

Install Brunch with a simple node.js package manager command:

npm install -g brunch

1. Create a new Brunch project: brunch new [--skeleton url]
   • skeleton specifies a skeleton from which your application will be initialized. The default skeleton (dead-simple) doesn't have any opinions about frameworks or libraries.
   • brunch.io/skeletons contains over 50 boilerplate projects, which you can use to init your app from.
2. 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 push state support.
3. Deploy with Brunch: brunch build --production
   • builds a project for distribution. By default it enables minification.

Learn

• Visit brunch.io
• Read brunch docs
• Follow us on Twitter: @brunch
• Ask questions on Stack Overflow with #brunch tag

Contributing

See the CONTRIBUTING.md document for more info on how to file issues or get your head into the Brunch's internals.

• To install edge version (from GitHub master branch): npm install -g brunch/brunch
• To enable debug mode, simply pass -d flag to any command like that: brunch build -d
• To create your own plugin, check out our plugin boilerplate as a starting point.

License

MIT license (c) 2021 Paul Miller paulmillr.com, Elan Shanker, Nik Graf, Thomas Schranz, Allan Berger, Jan Monschke, Martin Schürrer

See LICENSE file.

Brunch 4.0.0 (Feb 18, 2021)

• Breaking: Require node.js 12.13 or higher
• Breaking: Remove node-browser-modules:
  • This part of Brunch shimmed well-known node.js built-in modules and provided them for browsers - such as buffer and util
  • It increased Brunch package size massively and the modules themselves were outdated
  • Now, if you need to use "node.js" module, install proper shim from NPM
  • NPM packages can be used as before, this change only affects built-ins

Brunch 3.0.0 (Dec 16, 2019)

• Make config optional; and you could have it in package.json
• Build speed-ups up to 1.5x for some cases.
• Built-in webserver is now using serve-handler from micro(1) webserver. Custom webservers are unaffected.
• Breaking: Require node.js 10.16 or higher
• Breaking: Remove Bower and AMD support
• Breaking: Remove support for CoffeeScript brunch configs, emit a command that would compile coffee file to js
• Breaking: New node.js API - use brunch.build() from node without hassle
• Decrease package size by a huge amount:
  • Update Chokidar to 3.0
  • Remove or integrate many dependencies
  • Update dependencies to latest versions

Brunch 0.9 (Jan 10, 2012)

• Initial release with the current architecture.

See full changelog at .github/full_changelog.md