Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaplinjs/chaplin
HTML5 application architecture using Backbone.js
https://github.com/chaplinjs/chaplin
Last synced: about 2 months ago
JSON representation
HTML5 application architecture using Backbone.js
- Host: GitHub
- URL: https://github.com/chaplinjs/chaplin
- Owner: chaplinjs
- License: other
- Archived: true
- Created: 2012-02-11T14:14:04.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T06:52:38.000Z (over 1 year ago)
- Last Synced: 2024-04-26T22:17:27.844Z (about 2 months ago)
- Language: CoffeeScript
- Homepage: http://chaplinjs.org
- Size: 3.44 MB
- Stars: 2,854
- Watchers: 95
- Forks: 230
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: MIT-LICENSE.txt
Lists
- awesome-javascript - chaplin - An architecture for JavaScript applications using the Backbone.js library. (MVC Frameworks and Libraries / Runner)
- awesome-javascript-cn - chaplin
- awesome-stars - chaplin
- awesome-stars - chaplin
- awesome-focusnetworks - chaplin - An architecture for JavaScript applications using the Backbone.js library. (MVC Frameworks and Libraries / Runner)
- awesome-javascript - chaplin - An architecture for JavaScript applications using the Backbone.js library. (MVC Frameworks and Libraries / Runner)
- awesome-stars - chaplinjs/chaplin - HTML5 application architecture using Backbone.js (CoffeeScript)
- awesome-stars - chaplin - HTML5 application architecture using Backbone.js (CoffeeScript)
- awesome-javascript - chaplin - HTML5 application architecture using Backbone.js ` 📝 a year ago ` (MVC Frameworks and Libraries [🔝](#readme))
- awesome-javascript-libraries - chaplin - An architecture for JavaScript applications using the Backbone.js library. (MVC Frameworks and Libraries / Runner)
- awesome-javascript-builds-project - chaplin - An architecture for JavaScript applications using the Backbone.js library. (MVC Frameworks and Libraries / Runner)
- A-collection-of-awesome-browser-side-JavaScript-libraries-resources-and-shiny-things. - chaplin - An architecture for JavaScript applications using the Backbone.js library. (MVC Frameworks and Libraries / Runner)
- awesome-stars - chaplin
- awesome-javascript - chaplin
- awesome-javascript - chaplin - HTML5 application architecture using Backbone.js - ★ 2943 (MVC Frameworks and Libraries)
README
[](https://travis-ci.org/chaplinjs/chaplin)
# An Application Architecture Using Backbone.js
## Introduction
Chaplin is an architecture for JavaScript applications using the [Backbone.js](http://backbonejs.org/) library.
All information, commercial support contacts and examples are available at [chaplinjs.org](http://chaplinjs.org), comprehensive documentation and class reference can be found at [docs.chaplinjs.org](http://docs.chaplinjs.org).
[Download the latest release on chaplinjs.org](http://chaplinjs.org/#downloads). See below on how to compile from source manually.
## Building Chaplin
The Chaplin source files are originally written in the [CoffeeScript](http://coffeescript.org/) 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](http://nodejs.org/).
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
```
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](#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.
## [The Cast](https://github.com/chaplinjs/chaplin/blob/master/AUTHORS.md#the-cast)
## [The Producers](https://github.com/chaplinjs/chaplin/blob/master/AUTHORS.md#the-producers)