rump-server/README.md

Rump piece for adding a static server to the flow

# Rump Server
[![NPM](http://img.shields.io/npm/v/rump-server.svg?style=flat-square)](https://www.npmjs.org/package/rump-server)
![License](http://img.shields.io/npm/l/rump-server.svg?style=flat-square)
[![Issues](https://img.shields.io/github/issues/rumps/issues.svg?style=flat-square)](https://github.com/rumps/issues/issues)


## Status

### Master
[![Dependencies](http://img.shields.io/david/rumps/server.svg?style=flat-square)](https://david-dm.org/rumps/server)
[![Dev Dependencies](http://img.shields.io/david/dev/rumps/server.svg?style=flat-square)](https://david-dm.org/rumps/server#info=devDependencies)
<br>
[![Travis](http://img.shields.io/travis/rumps/server.svg?style=flat-square&label=travis)](https://travis-ci.org/rumps/server)
[![Appveyor](http://img.shields.io/appveyor/ci/jupl/rump-server.svg?style=flat-square&label=appveyor)](https://ci.appveyor.com/project/jupl/rump-server)
[![Codecov](http://img.shields.io/codecov/c/github/rumps/server.svg?style=flat-square&label=codecov)](https://codecov.io/github/rumps/server?view=all)

### Develop
[![Dependencies](http://img.shields.io/david/rumps/server/develop.svg?style=flat-square)](https://david-dm.org/rumps/server/develop)
[![Dev Dependencies](http://img.shields.io/david/dev/rumps/server/develop.svg?style=flat-square)](https://david-dm.org/rumps/server/develop#info=devDependencies)
<br>
[![Travis](http://img.shields.io/travis/rumps/server/develop.svg?style=flat-square&label=travis)](https://travis-ci.org/rumps/server)
[![Appveyor](http://img.shields.io/appveyor/ci/jupl/rump-server/develop.svg?style=flat-square&label=appveyor)](https://ci.appveyor.com/project/jupl/rump-server)
[![Codecov](http://img.shields.io/codecov/c/github/rumps/server/develop.svg?style=flat-square&label=codecov)](https://codecov.io/github/rumps/server?branch=develop&view=all)


## About
Rump Server is a Rump module that starts up a local server that serves built
assets using [pushserve](https://github.com/paulmillr/pushserve). For more
information, visit the [core repository](https://github.com/rumps/core).


## API
The following is appended to the core Rump API:

### `rump.addGulpTasks(options)`
This module adds the following tasks:

- `server` will start up the `watch` task, then start up BrowserSync on the
destination path.
- `server:prod` is the same as `server` with `options.environment` set to
`'production'` for a production build.
- `info:server` will display information on what this specific module does,
specifically the port number the local server is started at. This task is also
added to the `info` task.

### `rump.configure(options)`
Redefine options for Rump and Rump modules to follow. In addition to what
options Rump and other Rump modules offer, the following options are
available alongside default values:

#### `options.server.port` (`process.env.PORT` or `3000`)
This specifies which port to run pushserve under.

#### `options.server.pushState` (`false`)
This specifies whether to support assistance with HTML5 history API by serving
`index.html` on requests that don't have a file location.

#### `options.server.pushserve`
This specifies any options you want to override in pushserve. Visit the
[project page](https://github.com/paulmillr/pushserve) for specific options
available.

### `rump.configs.pushserve`
This contains the generated options that are passed to pushserve in the Gulp
task. This is a good way to see what options are generated based on defaults
and overrides.