/borschik-server

Dev HTTP server to process JS and CSS files with borschik

Primary LanguageJavaScriptMIT LicenseMIT

borschik-server

Build Status NPM version Dependency Status

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

This server is for development use only.

Default behavour

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

Some examples:

  1. You request is http://example.com/js/file.js. file.js exists, borschik-server reads this file and writes to output as is.
  2. 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)$" {
    # 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. You can find example in unit tests. In this example we add support for new ".styl" tech.

You can redefine pathResolver as well. Example. In this example we define builed files as file.min.js.

License

MIT