d1plo1d / brunch-time Goto Github PK

Inspried by other skeletons but includes a very minimalistic application structure and allows you to import more as you like.

As other Brunch users like to say, this is a Javascript, LESS, Backbone, Handlebars, Bower skeleton.

Brunch Time uses the following plugins:

• Javascript
• LESS
• Handlebars
• CSS
• CleanCSS
• UglifyJS

And has the following Bower packages installed:

• html5shiv
• lesshat
• normalize
• backbone
• lodash
• jquery
• mocha
• chai
• sinon
• sinon-chai

• Make sure you have Bower and Brunch installed first.

    npm install -g brunch
    npm install -g bower
  

• Now all you need to do clone the skeleton.

    brunch new https://github.com/sjlu/brunch-time.git
  

• To launch a server.

    brunch watch --server
  

  • Go to (localhost:3333)[http://localhost:3333/] to view your site and (localhost:3333/test.html)[http://localhost:3333/test.html] to run your tests.

• Make sure you add the Bower package you want in bower.json in the dependencies section.

  • You will also want to note that you can specify which file for Brunch to compile by listing it in the overrides section.

• Run the following to install the new package.

    bower install
  

• If load order matters, you'll need to modify config.coffee in the javascripts:order:before section.

You will need add your view controller into app/views and the appropriate HTML file into app/views/templates. Then add the proper instance in app/application.js and the route in app/router.js.

All you need to do is add the LESS file into the app/styles directory. Again, if order matters you'll need to specify this in config.coffee in the stylesheets:order:before section.

Add your test accordingly in test and add the test to test/all.js.

More documentation or information about Brunch can be found here which incldues things like how to deploy, examples, other skeletons and plugins.

MIT.