pushstate-server

by scottcorgan

scottcorgan / pushstate-server

Static file server that works with HTML5 Pushstate.

411 Stars 42 Forks Last release: Not found 105 Commits 25 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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 [-d directory] [-p port] [-f 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

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.