node package manager


Lightweight web framework


Lightweight web framework for node.js


  • Small, fully documented and easily extendable core
  • Advanced routing system (content type, method, host) with regexp support and placeholders
  • Compression support (gzip, deflate)
  • Static file serving support


General usage

var Crixalis = require('crixalis');
    /* Load plugin */
    /* Get router object */
    /* Add route with placeholder */
    .get('/hello/:name', function () {
        /* Set view for this response */
        this.view = 'json';
        /* Set data for view */
        this.stash.json = {
            message: ['Hello, ', '!'].join(
    /* Add simple route */
    .get('/info', function () {
        var that = this;
        /* Async response */
        this.async = true;
        require('fs').readFile('./package.json', function (error, result) {
            /* Handle error */
            if (error) {
            /* Set response body */
            that.body = result;
            /* Send result */
    /* Override default event handler */
    .on('default', function () {
    /* Start server on port 8080 */
    .start('http', 8080);


Complete API docs for latest version are available here.

You can generate docs yourself for offline browsing using make docs command.


Available core plugins

  • static Serve static files
  • compression Compress response using gzip or deflate compression (also works with static plugin)
  • jade Use jade template engine
  • coffee Compile coffee for frontend on the fly
  • less Compile less for frontend on the fly
  • request Thin wrapper around http.request and https.request
  • access Log requests to console
  • shortcuts Route declaration helpers, .get(), .post(), etc.

Static server

Crixalis comes with simple script for serving static files

    # Start web server on port `3000` and serve files from `~/www/`
    crixalis --port 3000 --path ~/www/
    # Start web server on port `8080` and serve files from current folder

Copyright and License

Copyright 2012-2016 Alexander Nazarov. All rights reserved.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.