Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lwsjs/lws
A lean, modular web server for rapid full-stack development.
https://github.com/lwsjs/lws
backend development-tools http-server lws server webapp
Last synced: 1 day ago
JSON representation
A lean, modular web server for rapid full-stack development.
- Host: GitHub
- URL: https://github.com/lwsjs/lws
- Owner: lwsjs
- License: mit
- Created: 2017-02-20T20:24:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-31T16:21:03.000Z (over 2 years ago)
- Last Synced: 2024-04-25T22:20:50.395Z (8 months ago)
- Topics: backend, development-tools, http-server, lws, server, webapp
- Language: JavaScript
- Homepage:
- Size: 833 KB
- Stars: 45
- Watchers: 4
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.org/package/lws)
[](https://www.npmjs.org/package/lws)
[](https://github.com/lwsjs/lws/network/dependents?dependent_type=REPOSITORY)
[](https://github.com/lwsjs/lws/network/dependents?dependent_type=PACKAGE)
[](https://github.com/lwsjs/lws/actions/workflows/node.js.yml)
[](https://github.com/feross/standard)
# lws
A lean, modular web server for rapid full-stack development.
Lws is an application core for quickly launching a local web server. Behaviour is added via plugins giving you full control over how requests are processed and responses created.
* Supports HTTP, HTTPS and HTTP2.
* Small and 100% personalisable. Load and use only the behaviour required by your project.
* Attach a custom view to personalise how activity is visualised.
* 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
```
Now your server is running, the next step is to attach some middleware to process requests.
### Using middleware plugins
Install and use some middleware ([lws-static](https://github.com/lwsjs/static) and [lws-index](https://github.com/lwsjs/index)) 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](https://github.com/koajs/koa/) as its middleware engine. Here is a trivial plugin example, save the following code as `example-middleware.js`:
```js
class ExamplePlugin {
middleware () {
return async (ctx, next) => {
ctx.body = 'Hello from lws!'
await next()
}
}
}
export default 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!
```
## Install
```
$ npm install --save-dev lws
```
## Documentation
* API Reference
* [Lws](https://github.com/lwsjs/lws/blob/master/doc/lws.md)
* [Middleware plugin](https://github.com/lwsjs/lws/blob/master/doc/middleware-plugin.md)
* [View plugin](https://github.com/lwsjs/lws/blob/master/doc/view-plugin.md)
## See also
* [lws plugin list](https://npms.io/search?q=keywords%3Alws-middleware).
* [local-web-server](https://github.com/lwsjs/local-web-server), an lws distribution with the most common plugins already installed.
* * *
© 2016-24 Lloyd Brookes \<[email protected]\>.
Tested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).