Nashville Plays Music

    creamer

    0.3.4 • Public • Published

    Creamer

    build status

    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 = flatiron.app
    layout = require __dirname + '/views/layout'
    app.use creamerlayout: layoutviewDir: __dirname + '/views'
     
    app.get '/'-> @bind('index')
     
    app.start 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

    app.router.get '/'-> @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

    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

    Keywords

    none

    Install

    npm i creamer

    DownloadsWeekly Downloads

    28

    Version

    0.3.4

    License

    none

    Last publish

    Collaborators

    • jackhq