Lloyd Brookes 68a7083ab9 Update README.md		7 years ago
bin	refactor cli	7 years ago
jsdoc2md	docs	8 years ago
lib	stats.. deps	7 years ago
test	upgrade deps.. test	7 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	7 years ago
LICENSE	switch to using lws.. clean up	7 years ago
README.md	Update README.md	7 years ago
package.json	2.0.0-pre2.1	7 years ago

README.md

This documentation is a work in progress

local-web-server

The modular development web server for productive front-end and full-stack engineers. Use this tool to:

Help build a web application using any architecture (static website, Single Page Application with client-side rendering, dynamic app with server-side rendering, Progressive Web App etc.)
Prototype a web service (REST API, microservice, websocket server application etc)

Agnostic which front-end framework (React, Polymer, Angular etc) you use, if any.

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

Being modular and extensible, there are many possibilites how to use this tool for more advanced usage.

Install

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

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