Skip to content

Latest commit

 

History

History
65 lines (55 loc) · 1.79 KB

README.md

File metadata and controls

65 lines (55 loc) · 1.79 KB
Raw

Brunch with js

This is a simple js skeleton for Brunch.

Main languages are JavaScript, Stylus and Handlebars.

Getting started

Clone the repo and run npm install & brunch build. See more info on the official site

Overview

config.coffee
README.md
/app/
  /assets/
    index.html
    images/
  /lib/
  models/
  styles/
  views/
    templates/
  application.js
  initialize.js
/test/
  functional/
  unit/
/vendor/
  scripts/
    backbone.js
    jquery.js
    console-helper.js
    underscore.js
  styles/
    normalize.css
    helpers.css
  • config.coffee contains configuration of your app. You can set plugins / languages that would be used here.
  • app/assets contains images / static files. Contents of the directory would be copied to build/ without change. Other app/ directories could contain files that would be compiled. Languages, that compile to JS (coffeescript, roy etc.) or js files and located in app are automatically wrapped in module closure so they can be loaded by require('module/location').
  • app/models & app/views contain base classes your app should inherit from.
  • test/ contains feature & unit tests.
  • vendor/ contains all third-party code. The code wouldn’t be wrapped in modules, it would be loaded instantly instead.

This all will generate public/ (by default) directory when brunch build or brunch watch is executed.

Other

Versions of software the skeleton uses:

  • jQuery 1.7.2
  • Backbone 0.9.1
  • Underscore 1.3.1
  • HTML5Boilerplate 3.0.3

The license is public domain. Use it however you want.