Static file server that works with HTML5 Pushstate.
JavaScript
Latest commit d070e34 Apr 6, 2018
Permalink
Failed to load latest commit information.
bin Fix tab space Jan 22, 2018
test Update dependencies Jul 11, 2017
.gitignore Add initial tests Sep 7, 2016
README.md Update README.md Apr 5, 2018
index.js Update dependencies Jul 11, 2017
package.json Lock minimist to version 1.2.0 Jan 22, 2018

README.md

pushstate-server

Static file server that works with HTML5 Pushstate.

For example, the route /some/pushstate/route will return the index.html file. But, /some/static/path/logo.png will return the logo.png static file.

Install

npm install pushstate-server --save

Usage

var server = require('pushstate-server');

server.start({
  port: 3000,
  directory: './public'
});

or for multiple directories

var server = require('pushstate-server');

server.start({
  port: 4200,
  directories: ['./public', './bower_components']
});

or bind to a particular host

server.start({
  port: 4200,
  host: '192.99.100.01',
  directories: ['./public', './bower_components']
});

Global Install

npm install -g pushstate-server
usage: pushstate-server [directory] [port] [file]

API

start(options[, callback])

  • start the pushstate static file server
options
  • port
    • set the port that the server should open
    • uses process.env.PORT if not specified, and defaults to port 9000 if none is available
  • directory
    • the path to the directory where the static assets will be served
    • defaults to public
  • file
    • Custom file to serve
    • defaults to index.html