Trackfinder NPM

trackfinder

Simple Express route finder

Getting Started

Install the module with: npm install trackfinder

var TrackFinder = require('trackfinder');

var app = express();


TrackFinder.register(app, {
    path:'./routes',
    config: config
});

This will load all files inside the routes directory. The most simple route file would look like this:

'use strict';

module.exports = function(app, options){
    console.log('- pets: register routes');

    app.get('/pets', function(req, res){
        res.json({
            pets: ['Colonel Meow', 'Casper', 'Chase No Face', 'Cherry Pop']
        });
    });
};

Documentation

(Coming soon)

Examples

(Coming soon)

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.