This project is a NodeJS application that permits to simply and quickly create a WEB local server. It can distribute any static or dynamic data and file. This will be useful to mock an API or serve your web site project.

This application creates, by default, a web server on http://localhost:8080/ that targets the website root from the launching directory.

You can specify :

• a domain,
• a port,
• a target directory for the* web site root*,
• a response time delay,
• an set of an API endpoints
• activate CORS.

The default webpage at the website root is index.html.

The web server supports using favicon.ico. It has to be located at the site root.

The web server supports all endpoint verbs.

The requested file content types is resolved with mime-types. This tool looks up the content type from the requested file extension. If nothing matches, default content type is used : application/octet-stream.

• A release of NodeJS >= 5.0.0 must be installed on your system.

Install the package on your system like this:

npm install -g dev-web-server

Uninstall the package by typing the next command:

npm uninstall -g dev-web-server

To launch the web server with default parameters:

dev-web-server

With this command, the application will create a web server :

• on URL http://localhost:8080/
• that will target website root to the launching directory
• without any time delay
• without API endpoints.

dev-web-server DOMAIN 0.0.0.0 PORT 1234 BASEDIR ..\rep\httpdocs DELAY 2000 ENDPOINTS ..\rep\server\my-endpoints.js

This command will launch a web server :

• accessible at url http://mon-domain.fr:1234/
• that will target website root to the directory ..\rep\httpdocs\
• with a time delay of 2000ms before each response
• with API endpoints defined in the file at path ..\rep\server\my-endpoints.js.

We can use a JSON configuration file at the launching directory : dev-web-server.json. Any argument in the command line will override the corresponding one in this file.

example :

{
  "domain": "0.0.0.0",
  "port": 13002,
  "baseDir": "./dist/test-pages",
  "delay": 0,
  "endPointsFilePath": "./api-proxy/api.js",
  "withCORS": "true"
}

The API endpoints can be defined in a NodeJS script file. It has to export a JavaScript hash object. Each one of its properties is endpoint declaration: the key is the URL part string and the value is a function to execute.

The endpoint function permits to define the response. It takes in arguments:

The sendSuccess callback allows to send a successful response. It contains the result object of the request. It takes in arguments:

The sendError callback allows to send a failed response. It contains the error result object of the request. It takes in arguments:

Example :

var Repository = {
  count:0
};

module.exports = {
  '/example': function (req, res, params, sendSuccess, sendError) {

    // Response result is: '{"test":"coucou","count":1}'.
    // HTTP code is 200
    sendSuccess(req, res, {
      test: 'coucou',
      count: Repository.count++
    });

  },

  '/exampleJSONP': function (req, res, params, sendSuccess, sendError) {

    // Response result is: myCallback({"test":"coucou","count":1}).
    // HTTP code is 200
    sendSuccess(req, res, {
      test: 'coucou',
      count: Repository.count++
    }, params.myCallbackName);

  },

  '/exampleError': function (req, res, params, sendSuccess, sendError) {

    // Response result is: '{"code":401,"message":"An error occurred during doing something"}'.
    // HTTP code is 401
    sendError(req, res, 401, 'An error occurred during doing something');

  }
};

To stop the server, type Ctrl+C.