Update README.md
This commit is contained in:
13
README.md
13
README.md
@ -15,29 +15,30 @@ Use this tool to:
|
|||||||
|
|
||||||
* Build fast, modern web applications using any tech, framework or architecture.
|
* Build fast, modern web applications using any tech, framework or architecture.
|
||||||
* Prototype back-end services (RESTful HTTP API, Microservice, websocket server etc.)
|
* Prototype back-end services (RESTful HTTP API, Microservice, websocket server etc.)
|
||||||
|
* Monitor activity, analyse performance, compare caching strategies etc.
|
||||||
|
|
||||||
Features:
|
Features:
|
||||||
|
|
||||||
* HTTP, HTTPS and HTTP2 support
|
* HTTP, HTTPS and HTTP2 support
|
||||||
* Create, share and consume middleware, view and server modules
|
* Modular. Create, share and consume middleware, view and server plugins.
|
||||||
* URL Rewriting, to local or remote destinations
|
* URL Rewriting to local or remote destinations
|
||||||
* Single Page Application support
|
* Single Page Application support
|
||||||
* Response mocking
|
* Response mocking
|
||||||
* Configurable access log
|
* Configurable access log
|
||||||
* Route blacklisting
|
* Route blacklisting
|
||||||
* HTTP Conditional Request support (cacheing)
|
* HTTP Conditional Request support
|
||||||
* Gzip response compression and much more
|
* Gzip response compression and much more
|
||||||
|
|
||||||
## Synopsis
|
## Synopsis
|
||||||
|
|
||||||
This package installs the `ws` command-line tool (take a look at the [usage guide](https://github.com/lwsjs/local-web-server/wiki/CLI-usage)). The most simple use case is to run `ws` without any arguments - this will **host the current directory as a static web site**.
|
This package installs the `ws` command-line tool (take a look at the [usage guide](https://github.com/lwsjs/local-web-server/wiki/CLI-usage)). The most simple use case is to run `ws` without any arguments - this will **host the current directory as a static web site**. Navigating to the server will render your `index.html` or show a directory listing, if you don't have one.
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ ws
|
$ ws
|
||||||
Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000
|
Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000
|
||||||
```
|
```
|
||||||
|
|
||||||
Another common use case is to **proxy certain requests to remote servers** (e.g. you'd like to use data from a different environment). For example, the following command would proxy `http://127.0.0.1:8000/api/users/1` to `https://internal-service.local/api/users/1`:
|
Another common use case is to **proxy certain requests to a remote server** if, for example, you'd like to use data from a different environment. The following command would proxy requests with a URL beginning with `http://127.0.0.1:8000/api/` to `https://internal-service.local/api/`:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ ws --rewrite '/api/* -> https://internal-service.local/api/$1`
|
$ ws --rewrite '/api/* -> https://internal-service.local/api/$1`
|
||||||
|
Reference in New Issue
Block a user