generator-kantele

Kantele 0.6 generator

Yeoman generator that scaffolds out a kantele 0.6 project.

Features

• Kantele 0.6
• Express 4
• Pure JavaScript/CoffeeScript
• optional Stylus
• optional Redis
• optional bower settings files

Getting Started

• Install: npm install -g yo
• Install: npm install -g kantele
• Make a project dir: mkdir myproject
• Go into the dir: cd myproject
• Run: yo kantele or yo kantele --coffee

Generators

yo kantele

Create a new Kantele project.

yo kantele app-name

Create a new additional Kantele app. Inside existing Kantele-project (created by kantele).

yo kantele:component component-name

Creates a [kantele component][] inside current folder.

Run inside of an project (created with yo kantele) in the /components/ folder, the new component will be put into /components/<component-name>.

Run with name started with d- prefix, the new component will be a new package, ready for publishing to NPM.

The package and class name will be derived from the dashed name, f.e d-new-comp.

Options

• --skip-install

  Skips the automatic execution of npm after scaffolding has finished.

• --coffee

  Add support for CoffeeScript.

Notes

If you use redis in you kantele-project take into account that REDIS_URL is in the format: redis://[db-number[:password]@]host:port[?option=value] see redis-url

To debug you app in the browser console use: APP and MODEL global variables.

MIT License

Copyright (c) 2014 by Artur Zayats

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.