chaplin's Introduction

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:

Download and install Node.js.
Open a shell (aka terminal aka command prompt) and type in the commands in the following steps.
Change into the Chaplin root directory.
Install all dependencies
```
npm install
```
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:

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

or alternatively, if you want code coverage reports