Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

The stupid development server. Reloads browser on file change. Serves CoffeeScript, EJS, and Stylus like a champ.

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 src
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .npmignore
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
README.md

servit

The stupid development server. Fork of workit

  • Reloads browser on source-file change.
  • Serves CoffeeScript, EJS, and Stylus like a champ.
  • Compiled output sent directly to browser for a pristine working directory.
  • No preprocessor caching so you're guaranteed to load the freshest code.

Built with Connect, Socket.io, Commander.js, and watchr. Inspired by visionmedia's serve and nodejitsu's http-server.

Installation

Via npm:

$ npm install -g servit

Usage

    Usage: servit [options] [dir]

    Options:
        -h, --help              output usage information
        -V, --version           output the version number
        -a, --address <string>  set hostname [127.0.0.1]
        -f, --format <string>   connect logger format [dev]
        -p, --port <number>     set port number [3000]

    Examples:

        Serve the current directory

            $ cd /var/www
            $ servit
            Serving /var/www at http://localhost:3000/

        Serve a specific directory

            $ servit /var/www/foo
            Serving /var/www/foo at http://localhost:3000/

        Serve a specific directory with options

            $ servit -a 192.168.0.1 -p 8080 /var/www/foo
            Serving /var/www/foo at http://192.168.0.1:8080/

Features

Preprocessing

servit transparently compiles .coffee, .ejs, and .styl files and sends the output directly to the browser. No rendered files are written to disk, so your working directory is left in a pristine state.

File extensions are taken literally. If you request .ejs, you'll get EJS:

$ curl http://localhost:3000/foo.ejs:

    <!DOCTYPE html>
    <title>Hello world</title>
    <link rel="stylesheet" href="foo.css">
    <script src="connect-reload.js"></script>
    <script src="foo.js"></script>
    <% include someAnotherTemplate %>

If you want the slightly-more-useful compiled html, request .htm or .html instead:

$ curl http://localhost:3000/foo.html:

    <!DOCTYPE html>
    <title>Hello world</title>
    <link rel="stylesheet" href="foo.css">
    <script src="connect-reload.js"></script>
    <script src="foo.js"></script>
    <p>Some another template content</p>

Same goes for .coffee vs .js and .styl vs .css.

Auto-reload

To enable automatic reloading of a page when a file in your project is created or changed, simply include the virtual connect-reload.js in your markup:

    <script src="connect-reload.js"></script>

License

(The MIT License)

Copyright (c) Patrik Votoček <patrik@votocek.cz>
Copyright (c) Shannon Moeller <me@shannonmoeller.com>

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.

Something went wrong with that request. Please try again.