Generate scaffolds for Chaplin.js using Yeoman. Expedite the process of creating single page web apps.
JavaScript CoffeeScript CSS
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
collection
collectionview
controller
destroy
model
template
test
view
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
LICENSE
README.md
lib.js
package.json

README.md

generator-chaplin Build Status

Chaplin

Generate scaffolds for Chaplin.js using Yeoman. Expedite the process of creating single page web apps.

Features:

  • Provides a working Chaplin.js boilerplate application powered by Yeoman, Grunt, Bower, and Browserify
  • Generate models, views, controllers, etc. on the fly
  • Coffeescript source maps out of the box
  • Livereload while developing

Installation

  1. Install Dependencies

     npm install -g bower coffee-script grunt-cli yo generator-chaplin
    
  2. Create a new project folder

  3. Initiate the generator in your project folder

     yo chaplin
    

Run the server

grunt w

On changing a file, the watch command will update the build on the fly and trigger livereload.

Scaffolding

Once you have generated an app, you can add additional scaffolding by executing these commands from the root of your project.

All scaffolding supports deep paths, so you could name a file foo or foo/bar/baz, which would end up as foo/bar/baz.coffee. Don't worry about the file extension, this is take care of automatically.

Controllers

yo chaplin:controller 'mycontroller'

This would create app/controllers/mycontroller.coffee (assuming no controller prefix in this case).

Models & Collections

Models

yo chaplin:model 'mymodel'

This would create app/models/mymodel.coffee.

Collections

yo chaplin:collection 'mycollection'

This would create app/models/mycollection.coffee.

Views & CollectionViews

Views

yo chaplin:view 'myview'

This would create app/views/myview.coffee.

CollectionViews

yo chaplin:view 'mycollectionview'

This would create app/views/mycollectionview.coffee.

Templates

Creates a handlebars tempalte file.

yo chaplin:templates 'foo'

This would create app/templates/foo.hbs

Destroy a project

yo chaplin:destroy

Testing

npm install -g generator-generator
npm test

License

MIT License