servit
v0.3.1
Published
The stupid development server. Serves CoffeeScript, EJS, and Stylus like a champ. Reloads browser on source-file change.
Downloads
8
Readme
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 caching so you're guaranteed to get the latest changes.
Built with Connect, Socket.io, Commander.js, and hound. Inspired by visionmedia's serve and nodejitsu's http-server.
Installation
Via npm:
$ npm install -g servitUsage
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 (I'm looking at you
connect-assets).
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>
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:
<!-- HTML -->
<script src="/connect-reload.js"></script>
License
(The MIT License)
Copyright (c) Patrik Votoček <[email protected]> Copyright (c) Shannon Moeller <[email protected]>
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.