Home

Awesome

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI js-standard-style

Upgraders, please read the release notes. For feedback, discussion and support see here.

local-web-server

A lean, modular web server for rapid full-stack development.

Use this tool to:

Local-web-server is a distribution of lws bundled with a "starter pack" of useful middleware.

Synopsis

This package installs the ws command-line tool (take a look at the usage guide).

Static web site

Running ws without any arguments will host the current directory as a static web site. Navigating to the server will render a directory listing or your index.html, if that file exists.

$ ws
Listening on http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000

Static files tutorial.

This clip demonstrates static hosting plus a couple of log output formats - dev and stats.

<img src="https://raw.githubusercontent.com/lwsjs/local-web-server/master/examples/log-format.gif" width="618px" title="Static static log output">

Single Page Application

Serving a Single Page Application (an app with client-side routing, e.g. a React or Angular app) is as trivial as specifying the name of your single page:

$ ws --spa index.html

With a static site, requests for typical SPA paths (e.g. /user/1, /login) would return 404 Not Found as a file at that location does not exist. However, by marking index.html as the SPA you create this rule:

If a static file is requested (e.g. /css/style.css) then serve it, if not (e.g. /login) then serve the specified SPA and handle the route client-side.

SPA tutorial.

<img src="https://raw.githubusercontent.com/lwsjs/local-web-server/master/examples/spa.gif" width="618px" title="SPA">

URL rewriting and proxied requests

Another common use case is to forward certain requests to a remote server.

The following command proxies blog post requests from any path beginning with /posts/ to https://jsonplaceholder.typicode.com/posts/. For example, a request for /posts/1 would be proxied to https://jsonplaceholder.typicode.com/posts/1.

$ ws --rewrite '/posts/(.*) -> https://jsonplaceholder.typicode.com/posts/$1'

Rewrite tutorial.

This clip demonstrates the above plus use of --static.extensions to specify a default file extension and --verbose to monitor activity.

<img src="https://raw.githubusercontent.com/lwsjs/local-web-server/master/examples/verbose.gif" width="618px" title="Proxy json requests to remote resource">

HTTPS and HTTP2

For HTTPS or HTTP2, pass the --https or --http2 flags respectively. See the wiki for further configuration options and a guide on how to get the "green padlock" in your browser.

$ ws --http2
Listening at https://mba4.local:8000, https://127.0.0.1:8000, https://192.168.0.200:8000

Built-in middleware stack

If you do not supply a custom middleware stack via the --stack option the following default stack will be used. It's designed to cover most typical web development scenarios.

NameDescription
Basic AuthPassword-protect a server using Basic Authentication
Body ParserParses the request body, making ctx.request.body available to downstream middleware.
Request MonitorFeeds traffic information to the --verbose output.
LogOutputs an access log or stats view to the console.
CorsSupport for setting Cross-Origin Resource Sharing (CORS) headers
JsonPretty-prints JSON responses.
RewriteURL Rewriting. Use to re-route requests to local or remote destinations.
BlacklistForbid access to sensitive or private resources
Conditional GetSupport for HTTP Conditional requests.
MimeCustomise the mime-type returned with any static resource.
CompressCompress responses using gzip.
SPASupport for Single Page Applications.
StaticServes static files.
IndexServes directory listings.

Further Documentation

See the wiki for plenty more documentation and tutorials.

Install

$ npm install -g local-web-server

© 2013-24 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.