brunch/brunch-guide

Name: brunch-guide

Owner: Brunch

Description: A comprehensive guide to Brunch

Created: 2015-03-28 15:45:56.0

Updated: 2018-01-18 06:31:07.0

Pushed: 2017-10-31 22:12:59.0

Homepage: http://brunch.io

Size: 444

Language: null

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

The Brunch.io Guide

This is an attempt at a comprehensive guide to Brunch, an excellent builder for browser apps that gives Grunt, Gulp, Broccoli et al. a run for their money. I adapted this from my (French language) article from early March 2015.

Is your English reading not so good? Check out our translations.

For a short 8-minute version that allows to learn 90% of Brunch features take a look at Brunches official micro guide.

Table of Contents

1. Brunch?! What?s Brunch?
2. Brunch vs. others
3. Task runners vs. builders
4. File-based processing vs. pipelines
5. Configuration and boilerplate vs. conventions
6. Full builds vs. incremental builds
7. The paramount importance of speed
8. Then why do I only ever hear about the others?
9. Getting started with Brunch
10. Should I use a skeleton?
11. Conventions and defaults
12. Built-in processing
13. Configuration files
14. Folders
15. CommonJS module wrapping
16. Sourcemaps
17. Watcher
18. Built-in web server
19. Plugin loading
20. Starting from scratch
21. How about a shortcut?
22. Just a couple files
23. Installing a starting set of Brunch modules
24. Our first build
25. Globals; because, reasons.
26. Getting modular again
27. Split targets
28. Using third-party module registries
29. A shot at templating
30. Using Brunch on a legacy codebase
31. Production builds
32. Watcher
33. Web server: built-in or custom
34. Writing your own server
35. And not just Node, either?
36. Plugins for all your build needs
37. Enabling a plugin
38. Fine-tuning through optional configuration
39. Brunch and CSS
40. Brunch and JavaScript
41. Brunch and templates
42. Brunch and development workflows
43. Brunch and web performance
44. Writing a Brunch plugin
45. Conclusion

Translations

This guide is also available in the following languages:

• French

To contribute translations, check out our guidelines.

Brunch version

This guide was written against Brunch 2.5. Most of it works in earlier versions, though; still, you should upgrade!

License

This work is © 2015 Christophe Porteneuve, licensed under the MIT license.

Contributing

I welcome all useful contributions: typos, bug fixes, rephrasings, better explanations or examples, extra information and demos, translations, etc.

Be sure to check our contribution guidelines!

Acknowledgments

The Brunch team deserves enormous applause and thanks for their amazing work on this tool. I write this as Brunch turns 4 already, and it's made my life easier (and that of hundreds of my JS trainees) for all that time! You guys rule!