ironhorse

Flatiron plugin for Express that borrows some of the good ideas of Union without the route and middleware nonsense.

npm install ironhorse
34 downloads in the last month

ironhorse

Collection of Flatiron plugins that simplify developing NodeJS web applications. Ironhorse uses Express under the hood, borrowing some of the good ideas of Union without the route and middleware nonsense.

Installation

$ npm install ironhorse

Quick Start

The minimal.js file in the example directory gives you the bare minimum lines of code to get started with Ironhorse.

var app = require('flatiron').app
  , logger = require('winston')

app.use(require('ironhorse/express'), {
});

// Do this inside route plugins
app.express.get('/', function(req, res) {
    res.send(200, 'Hello World!');
});

app.start(3000, function(err) {
    logger.info('App started on port 3000');
});

Features

  • Version-agnostic: you pass the constructed Express instance, or let ironhorse try to build one
  • Seamless integration of Express into a Flatiron app.
  • Delayed middleware and route setup.
  • Asynchronous initialization.

Delayed Middleware Setup

The order in which middlewares are passed to the express instance matters, which can be a bit of a headache if you want some plugins to define routes and middleware. That's why Ironhorse borrows the idea of 'before' and 'after' middlewares from Union, combined with the fact that middlewares are not setup in the express instance until the init phase of the flatiron app, giving the chance to other plugins to reorder some middlewares in the attach phase.

Additional plugins

Besides the base Express plugin, ironhorse ships with additional plugins:

  • config: nconf-based config loading to app.config
  • domains: mongoose database 'domains' with separate models and DB connections
  • passport: passport authentication middleware in app.passport
  • i18next: i18next translation library in app.i18next
  • kue: kue plugin that starts a job queue in app.jobs

Changelog

  • 0.0.9 [01-10-2013]
    • Added ready middleware to db domains to return 503 if connection breaks.
    • Removed libyaml in favor of js-yaml.
  • 0.0.8 [12-09-2013]
    • Added upload middleware to the filestore in the domains.
  • 0.0.7 [30-08-2013]
    • The models option of each domain accepts either a string path, or a list of paths.

License

(The MIT License)

Copyright (c) 2013 Conference Compass BV

Maintainer: Alberto Gonzalez alberto@conference-compass.com

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.

npm loves you