| 1 | # Brunch
|
| 2 |
|
| 3 | [](https://travis-ci.org/brunch/brunch)
|
| 4 | [](https://gitter.im/brunch/brunch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 5 |
|
| 6 | [](https://nodei.co/npm/brunch/)
|
| 7 | [](https://nodei.co/npm/brunch/)
|
| 8 |
|
| 9 | > HTML5 applications made easy.
|
| 10 |
|
| 11 | Fast front-end web app build tool with simple declarative config, seamless incremental compilation for rapid development, an opinionated pipeline and workflow, and core support for source maps
|
| 12 |
|
| 13 | ## First steps
|
| 14 |
|
| 15 | Install Brunch with a simple node.js package manager command: `npm install -g brunch`
|
| 16 |
|
| 17 | 1. **Create** a new Brunch project: `brunch new [--skeleton url]`
|
| 18 | - skeleton specifies a skeleton from which your application will be initialized.
|
| 19 | The default skeleton (dead-simple) doesn't have any opinions about frameworks or libraries.
|
| 20 | - [brunch.io/skeletons](http://brunch.io/skeletons) contains over 50
|
| 21 | boilerplate projects, which you can use to init your app from.
|
| 22 | 2. **Develop** with Brunch: `brunch watch --server`
|
| 23 | - tells Brunch to watch your project and incrementally rebuild it when source files are changed.
|
| 24 | The optional server flag launches a simple web server with push state support.
|
| 25 | - If you use OS X and want brunch to show system notification every time compilation error happens, you will need to install terminal notifier:
|
| 26 | `brew install terminal-notifier`
|
| 27 | 3. **Deploy** with Brunch: `brunch build --production`
|
| 28 | - builds a project for distribution. By default it enables minification.
|
| 29 |
|
| 30 | ## Learn
|
| 31 |
|
| 32 | * Visit [**brunch.io**](http://brunch.io)
|
| 33 | * Read [**brunch docs**](http://brunch.io/docs/getting-started)
|
| 34 | * Follow us on Twitter: [@brunch](http://twitter.com/brunch)
|
| 35 | * Ask questions on Stack Overflow with [#brunch](http://stackoverflow.com/questions/tagged/brunch) tag
|
| 36 |
|
| 37 | ## Contributing
|
| 38 |
|
| 39 | See the [CONTRIBUTING.md](https://github.com/brunch/brunch/blob/master/CONTRIBUTING.md) document for more info on how to file issues or get your head into the Brunch's internals.
|
| 40 |
|
| 41 | - To install edge version (from GitHub `master` branch): `npm install -g brunch/brunch`
|
| 42 | - To enable debug mode, simply pass `-d` flag to any command like that: `brunch build -d`
|
| 43 | - To create your own plugin, check out our [plugin boilerplate](https://github.com/brunch/brunch-boilerplate-plugin) as a starting point.
|
| 44 |
|
| 45 | ## License
|
| 46 |
|
| 47 | Brunch is released under the MIT License.
|
| 48 |
|
| 49 | Copyright (c) 2011-2018 Paul Miller, Elan Shanker, Nik Graf,
|
| 50 | Thomas Schranz, Allan Berger, Jan Monschke, Martin Schürrer
|
| 51 |
|
| 52 | Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 53 | of this software and associated documentation files (the "Software"), to deal
|
| 54 | in the Software without restriction, including without limitation the rights
|
| 55 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 56 | copies of the Software, and to permit persons to whom the Software is
|
| 57 | furnished to do so, subject to the following conditions:
|
| 58 |
|
| 59 | The above copyright notice and this permission notice shall be included in
|
| 60 | all copies or substantial portions of the Software.
|
| 61 |
|
| 62 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 63 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 64 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 65 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 66 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 67 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
| 68 | THE SOFTWARE.
|