rc1 / Servant

Command line static file server with fast live reloading, jade compiling, less compiling, directory listing.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Servant

giphy-downsized-large

Version 4.2.0

Lean express.js project for static website prototyping with jade & less/sass compiling, fast live reloading, directory listing etc.

Server any folder direct from the command line with just:

$ servant

Alternatively use as a minimal express.js server project for static websites with support for just-in-time less and jade file compiling.

Features

  • Very fast live reloading with ws and gaze
  • Compiles matching .less or .scss files for any .css requests
  • Compiles matching .jade files for any .html requests*
  • Optional .jade layout file in root
  • Directory listing

* Requests for '/' will also look for a index.jade file to compile.

Command line options

-w, --watch  Enable live reload
-p, --port
--watch-pattern  Pattern for watching foles

Watch pattern examples

  • watch everything (default) servant -w '/**/*'
  • watch all folders starting with a number (i.e. 0) servant -w --watch-pattern '/[0-9]*/**/*'

Command line tool usage:

Install globally:

$ npm install -g servant

From any folder:

$ servant

Using as boilerplate app:

$ git clone git@github.com:rc1/Servant.git
$ cd Servant
$ rm -rf .git
$ node app.js

Usage

With environment variables

WATCH=1 PORT=3001 node app.js

About

Command line static file server with fast live reloading, jade compiling, less compiling, directory listing.


Languages

Language:JavaScript 78.2%Language:HTML 11.3%Language:CSS 10.5%