README

borschik-server

HTTP server to processes JS and CSS files with borschik on demand.

This server is for development use only.

Default behavour

If file exists, response as is
Process files with _ prefix only (can be redefined in path-resolver)
Minimize is disabled
Freeze is disabled

Some examples:

You request is http://example.com/js/file.js. file.js exists, borschik-server reads this file and writes to output as is.
You request is http://example.com/js/_file.js. file.js doesn't exist, borschik-server removes _ prefix, reads file file.js and processes it with borschik.

Installation

npm install -g borschik-server

Usage

Just run borschik-server and setup your webserver. If you want to use borschik-server as init.d script follow this template for Ubuntu

Webserver configuration

You should setup your webserver (apache, lighttpd, nginx, etc.) to proxy http requests for static files to borschik-server.

Example nginx configuration:

location ~* "\.(css|js)quot; {
    # proxy all requests for css/js to borschik-server
    # use $uri (not $request_uri) to deal with rewrite
    proxy_pass http://127.0.0.1:8055$document_root$uri;
}

How to extend with new technologies

You can create you own server with this code

require('borschik-server').server({
    port: 8055,
    techResolver: require('../lib/tech-resolver')
});

This code references to you own tech-resolver

const ext2tech = {
    '.styl': {
        module: require('path').resolve(__dirname, '../processors/my-styl-processor'),
        contentType: 'text/css; charset=utf-8'
    }
};

var borschikServerTechResolver = require('borschik-server').techResolver;

// save techResolver interface
exports = borschikServerTechResolver;

// redefine getTech method
exports.getTech = function(extension) {
    var tech = ext2tech[extension];

    // go to borschik-server techs
    if (!tech) {
        return borschikServerTechResolver.getTech(extension);
    }

    return tech
};

You can redefine pathResolver as well.

License

MIT

Usage no npm install needed!