Creamer
Creamer is a server side flatiron plugin that provides coffeecup views and easy controller mounting.
install
npm install creamer
usage
flatiron = require 'flatiron'creamer = require 'creamer'app = flatironapplayout = require __dirname + '/views/layout'appuse creamerlayout: layoutviewDir: __dirname + '/views'appget '/'-> @bind'index'appstart 3000
api
options
option | Description |
---|---|
layout | coffeecup layout |
views | directory to your views |
controllers | directory to your controllers |
app.bind(template, data)
Parameter | Type | Required | Description |
---|---|---|---|
template | function | yes | coffeecup template |
data | object | no | any data you want to pass to your template |
example
approuterget '/'-> @bind'index'
app.registerHelper(name, fn)
register any helper to your coffeecup
Parameter | Type | Required? | Description |
---|---|---|---|
name | string | yes | name of helper |
fn | function | yes | coffeecup function |
example
app.registerHelper 'foo', (baz) -> baz + 'bar'
app.registerView(name, fn)
register view
Parameter | Type | Required? | Description |
---|---|---|---|
name | string | yes | name of helper |
fn | function | yes | coffeecup function |
roadmap
check issues
contribute
everyone is welcome to contribute. patches, bugfixes, new features
- create an issue on github so the community can comment on your idea
- fork
creamer
in github - create a new branch
git checkout -b my_branch
- create tests for the changes you made
- make sure you pass both existing and newly inserted tests
- commit your changes
- push to your branch
git push origin my_branch
- create an pull request
tests
npm install mocha -gnpm installnpm test
license
see LICENSE