rask v1.0.0

About

This is my restify-based app skeleton framework. It bounds some common frameworks and tools together, and gives (mostly me) us a production ready web app framework.

Hey! Do you know there is another great framework out there?

Yes, but why bother there is another one?

Since this one already setup following things

1. Restify (Dtrace!)
2. Log4js
3. Comment enhanced JSON conf files (auto parsing)
4. Cookies and Session support
5. Fully customizable static file serving
6. Ready to use client classes (enhanced restify client classes)
7. Ready to use util classes: actionQueue & workflow
8. WebSocket Server (with einaros/ws)

Usage

First

cd hellorask
npm init
npm install --save git://github.com/liyu1981/rask.git

Second

node_modules/rask/bin/rask gen main.js >main.js
node main.js

Then curl http://localhost:12345/hello for "world!".

App dir layout

etc/      <= for JSON conf files
 + log.json       => access with rask.conf.get('log')
 + server.json    => access with rask.conf.get('server')
log/      <= for log files (auto-create)
main.js <= app main

Test

cd rask/
npm install -g mocha
npm install

Then

cd rask/
mocha # simple test to output to console
mocha --require blanket -R html-cov >cov.html # coverage test

Check current coverage report http://htmlpreview.github.io/?https://github.com/liyu1981/rask/blob/master/cov.html .

main.js

require('rask')
  .server({
      // server options here, details in server.js
      serveStatic: false
    })
  .route(function(server) {
      // usual restify route registration here, you can
      //     server.get(/.*/, function(req, res, next) { });
      // or more common
      //     require('./myapi').register(server);
    })
  .start();