156 lines
3.7 KiB
Handlebars
156 lines
3.7 KiB
Handlebars
[](https://www.npmjs.org/package/local-web-server)
|
|
[](https://www.npmjs.org/package/local-web-server)
|
|
[](https://travis-ci.org/75lb/local-web-server)
|
|
[](https://david-dm.org/75lb/local-web-server)
|
|
[](https://github.com/feross/standard)
|
|
|
|
# local-web-server
|
|
A simple web-server for productive front-end development.
|
|
|
|
**Requires node v4.0.0 or higher**.
|
|
|
|
## Synopsis
|
|
Some typical use cases..
|
|
|
|
### Static site
|
|
Fire up your site on the default port:
|
|
```sh
|
|
$ tree
|
|
.
|
|
├── css
|
|
│ └── style.css
|
|
└── index.html
|
|
|
|
$ ws
|
|
serving at http://localhost:8000
|
|
```
|
|
|
|
### Single Page Application
|
|
|
|
Mark `index.html` as an SPA with client-side routing.
|
|
```sh
|
|
$ ws --spa index.html
|
|
```
|
|
|
|
With this option, routes with existing files (e.g. `/css/style.css`) will be served normally as static assets. Routes without an existing file (e.g. `/user/1`, `/login` etc.) are passed directly to your SPA. Without this option they would 404.
|
|
|
|
|
|
Blacklist certain paths, for example config files:
|
|
```sh
|
|
$ ws --forbid .json .yml
|
|
serving at http://localhost:8000
|
|
```
|
|
|
|
Reduce bandwidth with gzip compression:
|
|
```sh
|
|
$ ws --compress
|
|
```
|
|
|
|
When urls don't map to your directory structure, rewrite:
|
|
```sh
|
|
$ ws --rewrite /css=>/build/css
|
|
```
|
|
|
|
Rewrite to remote servers:
|
|
```sh
|
|
$ ws --rewrite /api=>http://api.example.com/api /npm=>http://registry.npmjs.com
|
|
```
|
|
|
|
|
|
## Install
|
|
Ensure [node.js](http://nodejs.org) is installed first. Linux/Mac users may need to run the following commands with `sudo`.
|
|
|
|
```sh
|
|
$ npm install -g local-web-server
|
|
```
|
|
|
|
## Distribute with your project
|
|
```sh
|
|
$ npm install local-web-server --save-dev
|
|
```
|
|
|
|
Then add an `start` script to your `package.json` (the standard npm approach):
|
|
```json
|
|
{
|
|
"name": "my-web-app",
|
|
"version": "1.0.0",
|
|
"scripts": {
|
|
"start": "ws"
|
|
}
|
|
}
|
|
```
|
|
This simplifies a rather specific-looking instruction set like:
|
|
|
|
```sh
|
|
$ npm install
|
|
$ npm install -g local-web-server
|
|
$ ws
|
|
```
|
|
|
|
to the following, server implementation and launch details abstracted away:
|
|
```sh
|
|
$ npm install
|
|
$ npm start
|
|
```
|
|
|
|
## Storing default options
|
|
To store per-project options, saving you the hassle of inputting them everytime, store them in the `local-web-server` property of your project's `package.json`:
|
|
```json
|
|
{
|
|
"name": "my-project",
|
|
"version": "0.11.8",
|
|
"local-web-server":{
|
|
"port": 8100
|
|
}
|
|
}
|
|
```
|
|
|
|
Or in a `.local-web-server.json` file stored in the directory you want to serve (typically the root folder of your site):
|
|
```json
|
|
{
|
|
"port": 8100,
|
|
"log-format": "tiny"
|
|
}
|
|
```
|
|
|
|
Or store global defaults in a `.local-web-server.json` file in your home directory.
|
|
```json
|
|
{
|
|
"port": 3000,
|
|
"refresh-rate": 1000
|
|
}
|
|
```
|
|
|
|
All stored defaults are overriden by options supplied at the command line.
|
|
|
|
To view your stored defaults, run:
|
|
|
|
```sh
|
|
$ ws --config
|
|
```
|
|
|
|
## mime-types
|
|
You can set additional mime-type/extension mappings, or override the defaults by setting a `mime` value in your local config. This value is passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine). Example:
|
|
|
|
```json
|
|
{
|
|
"mime": {
|
|
"text/plain": [ "php", "pl" ]
|
|
}
|
|
}
|
|
```
|
|
|
|
## Use with Google DevTools Workspaces
|
|
|
|
|
|
## Log Visualisation
|
|
Instructions for how to visualise log output using goaccess, logstalgia or gltail [here](https://github.com/75lb/local-web-server/wiki/Log-visualisation).
|
|
|
|
## API Reference
|
|
|
|
{{>main}}
|
|
|
|
* * *
|
|
|
|
© 2015 Lloyd Brookes <75pound@gmail.com>
|