flexigin-node is a Connect / Express middleware to serve flexigin requests.
If you have any questions or feedback, feel free to contact me using @goloroden on Twitter.
$ npm install flexigin-node
Using flexigin-node is easy. All you need to do is to add a reference to it within your Node.js application and use it as middleware for Connect or Express:
var http = require('http'),
path = require('path');
var express = require('express'),
flexigin = require('flexigin-node');
var app = express();
app.use(flexigin({
baseUrl: '/components',
basePath: path.join(__dirname, 'components')
}));
http.createServer(app).listen(3000);
The baseUrl setting defines the prefix for urls that shall be handled by flexigin-node. Please note that this url must start with a /, but must neither contain placeholders nor a trailing slash.
The basePath defines the directory where flexigin-node looks for components.
The client requests the html data for the user/profile component.
Hence a request is being sent to /components/user/profile/html. flexigin-node takes care of this request and looks inside the directory __dirname/components/user/profile for any files with the .html extension. It concatenates these files and returns them to the client.
flexigin-node has been developed using TDD. To run the tests, go to the folder where you have installed flexigin-node to and run npm test. You need to have mocha installed.
$ npm test
Additionally, this module can be built using Grunt. Besides running the tests, Grunt also analyses the code using JSHint. To run Grunt, go to the folder where you have installed flexigin-node and run grunt. You need to have grunt-cli installed.
$ grunt
The MIT License (MIT) Copyright (c) 2013 Golo Roden.
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.