bootable

Easy application initialization for Node.js.

npm install bootable
56 downloads in the last day
262 downloads in the last week
1 230 downloads in the last month

Bootable

Build Coverage Quality Dependencies

Bootable is an extensible initialization layer for Node.js applications.

Bootable allows initialization phases to be registered for an application. These phases will be executed sequentially during startup, after which the application will be ready to run.

Install

$ npm install bootable

Usage

Bootable is generally applicable to any Node.js application or application framework. Express will be used below, for illustrative purposes, as it is the most popular way of developing web applications.

Mixin Bootable

Create a new application and mixin the bootable module.

var express = require('express')
  , bootable = require('bootable');

var app = bootable(express());

Once mixed-in, the application will have two additional functions: app.boot and app.phase.

Register Phases

An application proceeds through a sequence of phases, in order to prepare itself to handle requests. Modules need to be configured, databases need to be connected, and routes need to be drawn.

Bootable packages phases for these common scenarios:

app.phase(bootable.initializers('config/initializers'));
app.phase(bootable.routes('routes.js'));

Custom phases can be registered as well, and come in synchronous and asynchronous flavors:

app.phase(function() {
  // synchronous phase
});

app.phase(function(done) {
  setTimeout(function() {
    // asynchronous phase
    done();
  }, 1000);
});

Boot Application

Call app.boot with a callback to boot your application. Phases will be executed sequentially, and the callback will be invoked when all phases are complete.

app.boot(function(err) {
  if (err) { throw err; }
  app.listen(3000);
});

This allows you to split off your initialization steps into separate, organized and reusable chunks of logic.

Tests

$ npm install
$ npm test

Credits

License

The MIT License

Copyright (c) 2013 Jared Hanson [http://jaredhanson.net/](http://jaredhanson.net/)

npm loves you