chaplin 0,0,1,0,-1,0,0,0 editorconfig travis-ci Bower npm

HTML5 application architecture using Backbone.js

2 years after MIT

Chaplin

Stories in Ready Build Status

An Application Architecture Using Backbone.js

Introduction

Chaplin is an architecture for JavaScript applications using the Backbone.js library.

All information, commercial support contacts and examples are available at chaplinjs.org, comprehensive documentation and class reference can be found at docs.chaplinjs.org.

Download the latest release on chaplinjs.org. See below on how to compile from source manually.

Building Chaplin

The Chaplin source files are originally written in the CoffeeScript meta-language. However, the Chaplin library file is a compiled JavaScript file which defines the chaplin module.

Our build script compiles the CoffeeScripts and bundles them into one file. To run the script, follow these steps:

  1. Download and install Node.js.

  2. Open a shell (aka terminal aka command prompt) and type in the commands in the following steps.

  3. Change into the Chaplin root directory.

  4. Install all dependencies

    npm install
  5. Start the build

    npm run build install

This creates these files in build dir:

  • chaplin.js – The library as a compiled JavaScript file.
  • chaplin.min.js – Minified. For production use you should pick this.

Running the Tests

Chaplin aims to be fully unit-tested. At the moment most of the modules are covered by Mocha tests.

How to run the tests:

  1. Follow the steps for building chaplin.
  2. Open a shell (aka terminal aka command prompt) and type in the commands in the following steps.
  3. Change into the Chaplin root directory.
  4. Start the test runner.

    npm test

or alternatively, if you want code coverage reports

   npm run coverage

Generated code coverage reports may be viewed by opening coverage/index.html in your browser.

Ending

The Cast

The Producers

Related Repositories

brunch-with-chaplin

brunch-with-chaplin

Boilerplate application for Brunch with Chaplin framework included. ...

chaplin-boilerplate-plain

chaplin-boilerplate-plain

Boilerplate application for the Chaplin.js library – written in plain JavaScript ...

chaplin-boilerplate

chaplin-boilerplate

Boilerplate application for the Chaplin.js library ...

chaplin-rails

chaplin-rails

Boilerplate Rails Application with Backbone, Chaplin and Require.js ...

brunch-with-chaplin-js

brunch-with-chaplin-js

JavaScript version of popular Chaplin skeleton for http://brunch.io ...


Top Contributors

paulmillr molily mehcode knuton karellm akre54 shvaikalesh andriijas Rendez YAndrew91 iangreenleaf zallek wprater Florian-R dbk2 flisky askmatey chadhietala Sija cbourgois Akaryatrh jonakyd cpsubrian cvd rubiii davidpfahler Krivega jeron-diovis ktusznio lukateake

Dependencies

package version
backbone ~1.3.3
underscore ~1.8.3
dev backbone.nativeview ~0.3.3
chai 3.5.x
coffee-coverage 1.0.1
coffee-script 1.10.x
coffeeify ~2.0.1
grunt ~0.4.5
grunt-browserify ~4.0.1
grunt-cli ~0.1.13
grunt-coffeelint ~0.0.15
grunt-contrib-compress 0.14.x
grunt-contrib-uglify ~0.11.1
grunt-contrib-watch ~0.6.1
grunt-istanbul 0.7.0
grunt-mocha-test ~0.12.7
grunt-transbrute 0.2.x
jquery 2.2.x
jsdom ~8.0.2
jsdom-assign shvaikalesh/jsdom-assign
mocha ~2.4.5
prompt ~0.2.14
sinon ~1.17.3
sinon-chai 2.8.x

Releases

-   1.0.0 zip tar
-   0.13.0 zip tar
-   0.12.0 zip tar
-   0.11.3 zip tar
-   0.11.2 zip tar
-   0.11.1 zip tar
-   0.11.0 zip tar
-   0.10.0 zip tar
-   0.9.0 zip tar
-   0.8.1 zip tar
-   0.8.0 zip tar
-   0.7.0 zip tar
-   0.6.1 zip tar
-   0.6.0 zip tar
-   0.5.0 zip tar
-   0.4.0 zip tar
-   0.3.0 zip tar
-   0.2.0 zip tar
-   0.1.0 zip tar