Files
hiring-test-one/README.md

44 lines
2.2 KiB
Markdown
Raw Normal View History

2017-06-17 00:41:38 +01:00
[![npm (tag)](https://img.shields.io/npm/v/local-web-server/next.svg)](https://www.npmjs.org/package/local-web-server)
[![npm module downloads](https://img.shields.io/npm/dt/local-web-server.svg)](https://www.npmjs.org/package/local-web-server)
2017-03-23 23:26:15 +00:00
[![Build Status](https://travis-ci.org/lwsjs/local-web-server.svg?branch=next)](https://travis-ci.org/lwsjs/local-web-server)
[![Dependency Status](https://david-dm.org/lwsjs/local-web-server/next.svg)](https://david-dm.org/lwsjs/local-web-server/next)
2015-10-30 11:31:59 +00:00
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
2017-03-23 21:42:21 +00:00
[![Join the chat at https://gitter.im/lwsjs/local-web-server](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lwsjs/local-web-server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2014-01-24 19:49:11 +01:00
2017-06-26 18:36:56 +01:00
**This documentation is a work in progress**
2015-11-20 09:52:51 +00:00
2015-02-01 14:04:17 +00:00
# local-web-server
2015-11-26 21:12:49 +00:00
2017-06-27 20:38:22 +01:00
The modular web server for productive full-stack development.
2017-06-26 23:26:30 +01:00
Use this tool to:
2017-06-26 18:36:56 +01:00
2017-06-27 20:38:22 +01:00
* Build a static website, dynamic website with server-side rendering, Single Page Application with client-side rendering, Progressive Web App etc. - any web application you like.
* Prototype a REST API, Microservice, websocket server or any other server-side application.
2017-06-26 18:36:56 +01:00
## Synopsis
This package installs the `ws` command-line tool. The most simple use case is to run `ws` without any arguments - this will host the current directory as a static web site.
```sh
$ ws
Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:8000
```
2017-06-26 18:41:32 +01:00
Opening any of the listed URLs in your browser will open your home page (`index.html` by default) if one exists, else show a directory listing.
## Advanced Usage
2017-06-26 20:44:13 +01:00
Being modular and extensible, features can be added or removed from `ws` in the shape of Middleware, ServerFactory or View modules. [See the wiki for full documentation and tutorials](https://github.com/lwsjs/local-web-server/wiki).
2015-11-27 09:31:28 +00:00
2015-02-01 14:04:17 +00:00
## Install
2013-06-04 14:23:50 +01:00
2017-06-27 20:38:22 +01:00
Requires node v7.6 or higher. Install the [previous release](https://github.com/lwsjs/local-web-server/tree/v1.x) for node >= v4.0.0.
2017-06-26 18:36:56 +01:00
2013-06-04 14:23:50 +01:00
```sh
2017-06-17 00:41:38 +01:00
$ npm install -g local-web-server@next
2013-06-04 14:23:50 +01:00
```
2015-11-08 22:09:07 +00:00
* * *
2017-03-13 23:44:11 +00:00
&copy; 2013-17 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).