brunch-with-ember-and-bootstrap

A Brunch skeleton for developing clean Ember applications with CoffeeScript, Stylus, Twitter Bootstrap and Font Awesome

npm install brunch-with-ember-and-bootstrap
12 downloads in the last week
24 downloads in the last month

Brunch with Ember and Bootstrap

An up-to-date Brunch skeleton for developing clean Ember applications with ease.

It was based the skeleton from Giovanni Collazo brunch-with-ember-reloaded but is now much more updated and complex now, tho I'd prefer to keep my original source.

Versions

Features

  • CoffeeScript - a little language that compiles into JavaScript.
  • Stylus - Expressive, dynamic, robust CSS pre-processor.
  • auto-reload-brunch - Adds automatic browser reloading support to brunch.
  • uglify-js-brunch - Adds UglifyJS support to brunch.
  • keyword-brunch - Adds Keyword support to brunch to replace some variables in the generated sources.

Getting started

Create a new project using this skeleton:

brunch new gh:huafu/brunch-with-ember-and-bootstrap <appname>
cd <appname>
brunch watch --server

Open http://localhost:3333 on your browser.

Production release

To create a production release (smaller vendor files, js and css packed), use the cake build command:

cake build

It'll generate a production ready public and create an archive of it in public.tgz that you can then backup or send to your servers.

Creating API documentation

You can easily create the API documentation fo your project using:

cake gen-doc

The API documentation will be generated in the apidocs folder. You can change this and other settings in yuidoc.json.

Ember Data

The Ember Data is already included in the project but you need to activate it in the file app/store.coffee.

You can easily disable it by prepending vendor/scripts/ember-data.js with a _, removing it from the config.coffee file and commenting out require 'store' from app/initialize.coffee.

Ember Bootstrap

Ember Bootstrap is adding some helpers to use Twitter Bootstrap elements easy with Ember. It comes with Views accessible as Handlebars template helpers too.

Generators

This skeleton makes use of scaffolt generators to help you create common files quicker. To use first install scaffolt globally with npm install -g scaffolt. Then you can use the following command to generate files.

scaffolt model <name>              → app/models/Name.coffee
    => App.Name = DS.Model.extend

scaffolt view <name>               → app/views/Name.coffee
    => App.NameView = Ember.View.extend

scaffolt controller <name>         → app/controllers/Name.coffee
    => App.NameController = Ember.Controller.extend

scaffolt objectcontroller <name>   → app/controllers/Name.coffee
    => App.NameController = Ember.ObjectController.extend

scaffolt arraycontroller <name>    → app/controllers/Names.coffee
    => App.NamesController = Ember.ArrayController.extend

scaffolt route <name>              → app/routes/Name.coffee
    => App.NameRoute = Ember.Route.extend

scaffolt template <name>           → app/templates/name.hbs

scaffolt component <comp-name>     → app/templates/components/comp-name.hbs
                                   → app/views/components/CompName.coffee
    => App.CompNameComponent = Ember.Component.extend
  • There's a few more commands you can use with scaffolt and also instruction on how to create your own generators, so make sure you check out the docs.
  • Each generator will automatically add the generated files to the corresponding initializer coffee file so that you won't have to add them yourself.

Testing

You can write your tests in the test folder, just make sure they are named *_test.coffee. You can customize the test to user PhantomJS, Chrome, Firefox, Safari or Opera on the test/karma.conf.js file. There's a lot of other settings there as well. Run tests with:

cake test

It needs some work to make it ready with Ember, and that will probably come in the next major release.

Updating

You have some cake tasks to help you update ember, ember-data and ember-bootstrap. More to come in the future.

# update Ember:
cake update-ember
# update Ember Data:
cake update-ember-data
# update Ember Bootstrap:
cake update-ember-bootstrap
# update Twitter Bootstrap:
cake update-bootstrap
# update Font Awesome:
cake update-font-awesome
# get/update Ember Date:
cake update-ember-date

License

All of brunch-with-ember-and-bootstrap is licensed under the MIT license.

Copyright (c) 2013 Huafu Gandon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you