Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A nodejs-powered development server for local software development
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
public
samples update read me
screenshots
src refactor connect-file-transfer to work with event emitter
test
.gitignore
.npmignore update .npmignore
.travis.yml add support for node 0.6 and bump version to 0.0.7
Guardfile
Makefile
README.md
package.json Pinned connect to 1.7.3 because something changed since then

README.md

Build Status

NServe is a nodejs-powered development server that is created to facilitate local software development. It is not designed for production use.

Version: 0.0.9

Terminal Screenshot

Features

  • Easy and Fast. One command and serve away.
  • Allow user-defined transfer rate to mimic the real situations.
  • Delay cross-domain mock web services, including GET and POST.
  • Live reload HTML/CSS/JS files. No need to manually refresh browsers.
  • More to come...

Installation

npm install nserve -g

or install the development version from source code

npm install {source code folder} -g

Usage

In the folder where you want to serve the files. Run the command below.

Usage: nserve [options] [root]

Options:

-V, --version                     output the version number
-h, --help                        output usage information
-p, --port <number>               specify the port number [3000]
-r, --rate <string>               specify the file transfer rate in Bps, e.g. 100K or 5M [unlimited]
-W, --webservice-folder <string>  specify the webservice folder name
-D, --webservice-delay <number>   specify the delay of the web service in millisecond [0]
-v, --verbose                     user the verbose mode
-L, --live-reload                 automatically reload HTML/CSS/JS files

and open http://localhost:3000 in your browser.

Running Test

Under the project folder,

$ npm install
$ npm test

Tips

  • How to use cross-domain mock web services?

    In the command line you have the option to specify the folder name where all the web services data are stored. In the meantime all the http requests that have the URLs starting with this folder name will be considered as web service calls. For example, suppose this folder is named as ws, if you have a file called data.json and another called error.json under the same ws folder, the GET request of http://localhost:3000/ws/data.json will have data.json returned as the payload for your ajax success callback, and the one of http://localhost:3000/ws/data.json?error=error.json will simulate the error situation and return error.json as payload for your ajax error callback. You can name these files howerever you want. You just need to make sure that the pairing data file and error file should stay under the same folder and the error file should be specified as the value of key error in the query.

    In the case of POST request, the principle is the same. The only difference is that the data.json file will mean the post result, and the error file should be put into the data body of request, as error=error.json, as opposed to in the query.

    For an example, please reference the ajax.html in the samples folder.

    By default, web service is not enabled. You can enable it by specifying the folder name in the command line with the option -W or --webservice-folder, and refer to that folder under the root where nserve is running.

    Also you have the ability to "slow down" the web services by using th option -D or --webservice-delay. You want to do that in the situation where you want to test your loader, for example.

License (MIT)

Copyright (c) 2011 Mo Wang <mo.oss.wang@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.