Download

Table of Contents

1. About
   1. Core
   2. Chaplin
2. Tasks
   1. Extras
   2. Generators

About

This is a starter project template to build rich client-side experiences with Chaplin and CoffeeScript using Node.js. This skeleton is aimed at leveraging packages to develop and build, while providing a set of unified tasks and definitions to focus less on configuration and setup.

Core

This starter project builds on top of core packages and utilities. In addition, there are variants of this project that leverage other tools, such as Cordova or server extras. Visit this page for more information on core functionality. Visit this page for more information on Cordova specifics.

Chaplin

The following additional packages are included:

• CoffeeScript as the primary language.
• Chaplin for the base framework.
• Backbone.js for the library Chaplin builds on top of.
• jQuery as a dependency of Backbone.
• Lo-Dash as a dependency of Backbone.
• Exoskeleton as a replacement for Backbone, jQuery, and Lo-Dash. (optional)
• Rivets.js for data binding. (optional)
• Davy for promises with Exoskeleton. (optional)
• ECO for templating Chaplin views with CoffeeScript.
• LESS to write better styles that compile to CSS.
• LESS Hat for additional mixins for working with LESS.

Tasks

Additional tasks are included for working with Chaplin. Visit this page for more information on tasks.

Extras

These commands add additional features/items to the project that are not included by default.

add:lodash

rem:lodash

Add/remove Lo-Dash to/from the project for utilities. This is primarily here for Exoskeleton.

add:rivets

rem:rivets

Add/remove Rivets to/from the project for data binding.

add:exoskeleton

rem:exoskeleton

Add/remove Exoskeleton to/from the project for a more lean Backbone. Note that this task removes/adds jQuery and Lo-Dash from/to the project.

add:davy

rem:davy

Add/remove Davy to/from the project for lightweight promises. Use this if you are using Exoskeleton and need promise support.

Generators

These generators are provided to generate components without writing boilerplate code. Unit test files are automatically generated for Chaplin components. For Chaplin views, a template and stylesheet is also provided in addition to the source.

generate model=[name]

destroy model=[name]

Generate/destroy a Chaplin model.

generate collection=[name]

destroy collection=[name]

Generate/destroy a Chaplin collection. Generating a Chaplin collection will also generate its corresponding model. Specify the name in singular form, as the collection's name will be automatically pluralized.

generate view=[name]

destroy view=[name]

Generate/destroy a Chaplin view, ECO template, and LESS stylesheet.

generate collectionview=[name]

destroy collectionview=[name]

Generate/destroy an Chaplin collection view, ECO template, and LESS stylesheet. Generating a Chaplin collection view will also generate the matching item view.

generate controller=[name]

destroy controller=[name]

Generate/destroy an Chaplin controller.