Lloyd Brookes 9f850b8962 readme		8 years ago
bin	refactor cli	8 years ago
jsdoc2md	docs	9 years ago
lib	correct version in stats	8 years ago
test	correct version in stats	8 years ago
.coveralls.yml	docs.. tidy.. examples.. --rewrite	9 years ago
.gitignore	mock responses.. example	9 years ago
.travis.yml	move docs to wiki and examples to separate project	8 years ago
LICENSE	switch to using lws.. clean up	8 years ago
README.md	readme	8 years ago
package.json	readme	8 years ago

README.md

This documentation is a work in progress

local-web-server

The modular web server for productive full-stack development.

Use this tool to:

Build a static website, dynamic website with server-side rendering, Single Page Application with client-side rendering, Progressive Web App etc. - any web application you like.
Prototype a REST API, Microservice, websocket server or any other server-side application.

Synopsis

This package installs the ws command-line tool. The most simple use case is to run ws without any arguments - this will host the current directory as a static web site.

$ ws
Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000

Opening any of the listed URLs in your browser will open your home page (index.html by default) if one exists, else show a directory listing.

Advanced Usage

Being modular and extensible, features can be added or removed from ws in the shape of Middleware, ServerFactory or View modules. See the wiki for full documentation and tutorials.

Install

Requires node v7.6 or higher. Install the previous release for node >= v4.0.0.

$ npm install -g local-web-server@next