Yo generator for Chaplin (JavaScript, Stylus, Ejs)
JavaScript CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
all
app
collection
controller
helper
model
style
template
test
view
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
LICENSE
README.md
package.json

README.md

Chaplin.js generator (JavaScript, Stylus, Ejs) Build Status

A Chaplin.js generator for Yeoman that provides a functional boilerplate Chaplin app out of the box. You also get access to a number of sub-generators which can be used to easily create individual models, views, collections and so on.

Usage

Install: npm install -g generator-chaplinjs

Make a new directory and cd into it:

mkdir my-new-project && cd $_

Run yo chaplinjs, optionally passing an app name:

yo chaplinjs [app-name]

Generators

Available generators:

  • chaplinjs:all name action
  • chaplinjs:controller name [actions...]
  • chaplinjs:helper name
  • chaplinjs:collection name [--model=model-name]
  • chaplinjs:model name
  • chaplinjs:view name [--path=path] [--extend=extend-name] [--all]
  • chaplinjs:template name [--path=path]
  • chaplinjs:style name [--path=path]

Typical workflow

yo chaplinjs # generates your application base and build workflow
yo chaplinjs:controller users index
yo chaplinjs:helper users
yo chaplinjs:collection users --model=user
yo chaplinjs:model user
yo chaplinjs:view index --path=users --extend=page
yo chaplinjs:template index-page --path=users
yo chaplinjs:style index-page --path=users
grunt server

File structure

|--src/
   |--app/
      |--controllers/
         |--base/
      |--models/
         |--base/
      |--views/
         |--base/
         |--styles/
         |--templates/
      |--helpers/
      |--config/
         |--routes.js
         |--application.js
      |--assets/
      |--lib/
         |--utils.js
         |--error-handler.js
      |--application.js
      |--mediator.js
      |--main.js
      |--initialize.js
   |--test/
      |--automation
      |--benchmark
      |--spec
         |--controllers/
         |--models/
         |--helpers/
         |--lib/
         |--views/
         |--index.html
         |--coverage.html
         |--helper.js
         |--initialize.js
   |--vendor/
   |--index.html
|--Gruntfile.js
|--bower.json
|--yuidoc.json
|--package.json

License

MIT License