wpstudio/hiring-test-one
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Lloyd Brookes
2014-06-17 13:45:00 +01:00
parent f6819993cf
commit 1bc7b70e73
1 changed files with 7 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -3,22 +3,20 @@
[![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server) [![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server)
![Analytics](https://ga-beacon.appspot.com/UA-27725889-12/local-web-server/README.md?pixel) ![Analytics](https://ga-beacon.appspot.com/UA-27725889-12/local-web-server/README.md?pixel)
local-web-server #local-web-server
================
Fires up a simple, CORS-enabled, static web server on a given port. Use for local web development or file sharing (directory browsing enabled). Fires up a simple, CORS-enabled, static web server on a given port. Use for local web development or file sharing (directory browsing enabled).
![local-web-server](http://75lb.github.io/local-web-server/ws.gif) ![local-web-server](http://75lb.github.io/local-web-server/ws.gif)
Install ##Install
-------
Ensure [node.js](http://nodejs.org) is installed first. Linux/Mac users may need to run the following commands with `sudo`. Ensure [node.js](http://nodejs.org) is installed first. Linux/Mac users may need to run the following commands with `sudo`.
##Globally ###Globally
```sh ```sh
$ npm install -g local-web-server $ npm install -g local-web-server
``` ```
##Deployed with your project ###Deployed with your project
```sh ```sh
$ npm install local-web-server --save-dev $ npm install local-web-server --save-dev
``` ```
@ -46,8 +44,7 @@ $ npm install
$ npm start $ npm start
``` ```
Usage ##Usage
-----
``` ```
Usage Usage
$ ws <server options> $ ws <server options>
@ -110,8 +107,7 @@ Or silence:
$ ws -f none $ ws -f none
``` ```
Storing default options ##Storing default options
-----------------------
To store per-project options, saving you the hassle of inputting them everytime, store them in the `local-web-server` property of your project's `package.json`: To store per-project options, saving you the hassle of inputting them everytime, store them in the `local-web-server` property of your project's `package.json`:
```json ```json
{ {
@ -147,15 +143,6 @@ To view your stored defaults, run:
$ ws --config $ ws --config
``` ```
##Deploy the web server with your project
It's quite common to see a set of installation instructions like this:
```sh
$ npm install
$ npm install -g
```
##Use with Logstalgia ##Use with Logstalgia
local-web-server is compatible with [logstalgia](http://code.google.com/p/logstalgia/). local-web-server is compatible with [logstalgia](http://code.google.com/p/logstalgia/).
@ -174,8 +161,7 @@ $ ws -f logstalgia | logstalgia -
![local-web-server with logstalgia](http://75lb.github.io/local-web-server/logstagia.gif) ![local-web-server with logstalgia](http://75lb.github.io/local-web-server/logstagia.gif)
Use with glTail ##Use with glTail
---------------
To use with [glTail](http://www.fudgie.org), write your log to disk using the "default" format: To use with [glTail](http://www.fudgie.org), write your log to disk using the "default" format:
```sh ```sh
$ ws -f default > web.log $ ws -f default > web.log