Files
hiring-test-one/README.md

90 lines
2.3 KiB
Markdown
Raw Normal View History

2013-09-23 18:48:27 +02:00
[![NPM version](https://badge.fury.io/js/local-web-server.png)](http://badge.fury.io/js/local-web-server)
2014-01-24 19:49:11 +01:00
[![Dependency Status](https://david-dm.org/75lb/local-web-server.png)](https://david-dm.org/75lb/local-web-server)
![Analytics](https://ga-beacon.appspot.com/UA-27725889-12/local-web-server/README.md?pixel)
2013-09-23 18:48:27 +02:00
local-web-server
================
2014-02-09 09:23:59 +01:00
Fires up a simple, static web server on a given port. A pure Javascript (and more reliable) alternative to `$ python -mSimpleHTTPServer 8000`.
Use for local web development or file sharing (directory browsing enabled). Plays well with Google Chrome Workspaces.
2013-06-04 14:23:50 +01:00
Install
2013-06-04 14:26:42 +01:00
-------
2013-06-04 14:23:50 +01:00
Install [Node.js](http://nodejs.org), then run
```sh
$ npm install -g local-web-server
```
2013-06-04 14:26:42 +01:00
*Linux/Mac users may need to run the above with `sudo`*
2013-06-04 14:23:50 +01:00
Usage
2013-06-04 14:26:42 +01:00
-----
2014-02-09 09:23:59 +01:00
```
2014-02-09 09:37:04 +01:00
ws [--directory|-d <directory>] [--port|-p <port>] [--log-format|-f dev|default|short|tiny]
2014-02-09 09:23:59 +01:00
```
2013-06-05 20:16:10 +01:00
From the folder you wish to serve, run:
```sh
2013-06-21 18:35:12 +01:00
$ ws
serving at http://localhost:8000
```
2013-06-21 18:35:12 +01:00
If you wish to serve a different directory, run:
```sh
$ ws -d ~/mysite/
serving ~/mysite at http://localhost:8000
```
2014-02-09 09:23:59 +01:00
If you wish to override the default port (8000), use `--port` or `-p`:
```sh
2013-06-21 18:35:12 +01:00
$ ws --port 9000
serving at http://localhost:9000
```
2013-06-21 18:35:12 +01:00
2014-02-09 08:19:26 +01:00
Use a built-in or custom [Connect logger format](http://www.senchalabs.org/connect/logger.html) with `--log-format`:
2013-06-21 18:35:12 +01:00
```sh
$ ws --log-format short
2013-06-04 14:23:50 +01:00
```
2013-06-05 20:06:54 +01:00
2013-06-15 00:41:43 +01:00
Use with Logstalgia
2013-06-15 00:52:03 +01:00
-------------------
2013-06-15 00:50:27 +01:00
The "default" log-format is compatible with [logstalgia](http://code.google.com/p/logstalgia/).
2013-06-15 00:41:43 +01:00
2013-06-15 00:47:51 +01:00
If you wrote your log output to disk, like so:
2013-06-15 00:41:43 +01:00
```sh
2013-06-15 00:47:51 +01:00
$ ws --log-format default > web.log
2013-06-15 00:41:43 +01:00
```
2013-06-15 00:50:27 +01:00
Then you could visualise in logstalgia with:
2013-06-15 00:41:43 +01:00
```sh
$ logstalgia web.log
```
2013-06-15 00:47:51 +01:00
Alternatively, pipe directly from ws into logstalgia for real-time visualisation:
2013-06-15 00:41:43 +01:00
```sh
2013-06-15 00:47:51 +01:00
$ ws --log-format default | logstalgia -
2013-06-15 00:41:43 +01:00
```
2014-02-05 15:28:23 +01:00
Use with glTail
---------------
2014-02-09 09:23:59 +01:00
To use with [glTail](http://www.fudgie.org), write your log to disk using the "default" format:
2014-02-05 15:28:23 +01:00
```sh
$ ws -f default > web.log
```
2014-02-09 09:23:59 +01:00
Then specify this file in your glTail config:
2014-02-05 15:28:23 +01:00
```yaml
servers:
dev:
host: localhost
source: local
files: /Users/Lloyd/Documents/MySite/web.log
parser: apache
color: 0.2, 0.2, 1.0, 1.0
```
2014-01-24 19:49:11 +01:00
[![NPM](https://nodei.co/npm-dl/local-web-server.png?months=3)](https://nodei.co/npm/local-web-server/)