creamer

A flatiron plugin for dynamic coffeecup templates

Creamer

Creamer is a server side flatiron plugin that provides coffeecup views and easy controller mounting.

npm install creamer

flatiron = require 'flatiron'
creamer = require 'creamer'
app = flatiron.app
layout = require __dirname + '/views/layout'
app.use creamerlayout: layoutviewDir: __dirname + '/views'
 
app.get '/'-> @bind('index')
 
app.start 3000

options

option | Description -----------|----------|-------------|------------- layout | coffeecup layout views | directory to your views controllers| directory to your controllers

ParameterTypeRequiredDescription
templatefunctionyescoffeecup template
dataobjectnoany data you want to pass to your template

example

app.router.get '/'-> @bind('index')

register any helper to your coffeecup

ParameterTypeRequired?Description
namestringyesname of helper
fnfunctionyescoffeecup function

example

app.registerHelper 'foo', (baz) -> baz + 'bar'

register view

ParameterTypeRequired?Description
namestringyesname of helper
fnfunctionyescoffeecup function

roadmap

check issues

contribute

everyone is welcome to contribute. patches, bugfixes, new features

  1. create an issue on github so the community can comment on your idea
  2. fork creamer in github
  3. create a new branch git checkout -b my_branch
  4. create tests for the changes you made
  5. make sure you pass both existing and newly inserted tests
  6. commit your changes
  7. push to your branch git push origin my_branch
  8. create an pull request

tests

npm install mocha -g
npm install
npm test
 

license

see LICENSE