lws

lws

This documentation is a work in progress.

A tool for quickly launching a personalised Node.js HTTP, HTTPS or HTTP2 local web server. It's intended to facilitate rapid, full-stack Web Platform development.

Its has a very lean core - behaviour is added via plugins giving you full control over what features are activated, how HTTP requests are handled, responses created, caches controlled, activity visualised etc.

Core features.

• Launch an HTTP, HTTPS or HTTP2 server.
• Use one or more custom or pre-built middleware plugins to attach the behaviour required by your project.
• Attach a custom view to personalise how activity is visualised.
• Store config at any level - project, user or system.
• Programmatic and command-line APIs.

Synopsis

Core usage

Launch an HTTP server on the default port of 8000.

$ lws
Listening at http://mba4.local:8000, http://127.0.0.1:8000, http://192.168.0.200:8000

For HTTPS or HTTP2, pass the --https or --http2 flags respectively.

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

Using middleware plugins

Install and use some middleware to serve static files and directory listings.

$ npm install --save-dev lws-static lws-index

$ lws --stack lws-static lws-index
Listening at http://mba4.local:8000, http://127.0.0.1:8000, http://192.168.0.200:8000

The current directory will now be available to explore at http://127.0.0.1:8000.

Install and use logging middleware. Note the lws- prefix is optional when supplying module names to --stack.

$ npm install --save-dev lws-log

$ lws --stack log static index --log.format combined
Listening at http://mba4.local:8000, http://127.0.0.1:8000, http://192.168.0.200:8000
::ffff:127.0.0.1 - GET /lws.config.js HTTP/1.1 200 52 - 8.259 ms
::ffff:127.0.0.1 - GET /package.json HTTP/1.1 200 399 - 1.478 ms

Creating a custom middleware plugin

Lws uses Koa as its middleware engine. Here is a trivial plugin example, save the following code as example-middleware.js:

class ExamplePlugin {
  middleware () {
    return function (ctx) {
      ctx.body = 'Hello from lws!'
    }
  }
}

module.exports = ExamplePlugin

Now launch an HTTP server using this middleware.

$ lws --stack example-middleware.js
Listening at http://mba4.local:8000, http://127.0.0.1:8000, http://192.168.0.200:8000

$ curl http://127.0.0.1:8000
Hello from lws!

Documentation

• Tutorials
• API Reference
  • Lws
  • Middleware plugin
  • View plugin

---

© 2016-19 Lloyd Brookes <[e-mail]>. Documented by jsdoc-to-markdown.