Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 3.35 KB

README.md

File metadata and controls

79 lines (62 loc) · 3.35 KB
Raw

Brunch with Chaplin

This is HTML5 application, built with Brunch and Chaplin.

Getting started

  • Install Brunch: npm install -g brunch.
  • Install Brunch plugins: npm install.
  • Watch the project with continuous rebuild by brunch watch --server. This will also launch HTTP server.
  • Build the minified project with brunch build --optimize.
  • Open the public/ dir to see the result.
  • Write your code in app dir, put scripts in vendor dir.

See Chaplin site for docs and more info.

For newcomers

Brunch with Chaplin is a skeleton (boilerplate) for Brunch based on Chaplin architecture.

Requires Brunch 1.6+.

Example application built with the skeleton: Ost.io.

Difference from Chaplin Boilerplate

Chaplin Boilerplate is a official boilerplate all for chaplin. This skeleton is almost the same, except a few changes:

  • Added Header.
  • CommonJS is used instead of AMD, because it's easier to use & debug.

Features

  • HTML5Boilerplate html & css are included.
  • CoffeeScript + Stylus + Handlebars as app languages (you can change this to anything you want)
  • Backbone as main MVC/MVP library, Chaplin as meta-framework.
  • Support of IE8 and up.
  • Cross-module communication using the Mediator and Publish/Subscribe patterns
  • Controllers for managing individual UI views
  • Rails-style routes which map URLs to controller actions
  • An application view as dispatcher and view manager
  • Extended model, view and collection classes to avoid repetition and enforce conventions
  • Strict memory management and object disposal
  • A collection with additional manipulation methods for smarter change events
  • A collection view for easy and intelligent list rendering

Authentication

If you build an application with authentication, there are some useful abstractions for it out there: https://github.com/chaplinjs/chaplin-auth.

License

The MIT license.

Copyright (c) 2012 Paul Miller (http://paulmillr.com/)

Copyright (c) 2012 Moviepilot GmbH, 9elements GmbH et al.

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.