route-me v1.0.4

route-me

Route-me is a lightweight framework designed for quickly and easily setting up routes for a local server. Using route-me, you can define the behavior of your server by specifying a route using a RESTFUL method (currently only handles GET, POST, PUT, PATCH, and DELETE), path, and callback function. Route-me will handle the rest!

Installation

Open your favorite terminal and install the route-me framework via npm:

$ npm i route-me

Basic Use

Simply require route-me as a dependency, and instantiate a new router to which you can add your own custom routes.

Define your custom routes within a separate module. For these examples, we are using the filename routes.js within the root directory of the application. You will need to export the router at the bottom of the file, after definining the routes. Then, require this module into your server file.

file: routes.js

const Router = require('route-me');
const router = new Router();
// routes defined here
module.exports = router;

Defining Routes

Create methods on your router by specifying a RESTFUL method in lowercase (.get, .post, .put, .patch, or .delete), a URL path (as a string), and callback function. This is the general template:

file: routes.js

const Router = require('route-me');
const router = new Router();

router.get('/testPath', function(req, res) {
    res.write('Your message to the client here');
    res.end();
});

module.exports = router;

Using the routes within a server

Require in the routes file that you have created and pass a call to router.route into your server.

file: server.js

const http = require('http');
const router = require('./routes'); //Wherever your routes are defined

http.createServer(router.route())
    .listen(3000);

Todos

• Handle other RESTFUL methods beyond GET, POST, PUT, PATCH, and DELETE
• Handle many types of data
• Enable responses beyond writing to the client

License

MIT