upload-test-server v2.1.0

upload-test-server

Small node server with a CLI to test file uploads. Powered by hapi.

Why?

I searched for a simple and easy server that does just one thing:
Letting me test file uploads with front end gui stuff I work on.

Install

npm install -g upload-test-server

Run it

upload-test-server start

Starts the server on localhost:8989 and accepts file uploads at http://localhost:8989/upload.
By default all uploaded files are saved to the current working directory.
If the upload folder doesn't exist, it's created as soon as a file is uploaded.

See options for more

The server accepts any origin, so you shouldn't have any trouble with cors.
This also means don't use this stuff in production!

General usage

Usage: upload-test-server command


  Options:

    -V, --version  output the version number
    -h, --help     output usage information


  Commands:

    start [options]  Start the upload server.

Server options

Usage: start [options]

  Start the upload server.


  Options:

    -h, --host [host]         Host for the server. Defaults to localhost.
    -p, --port [port]         Port to listen on. Defaults to 8989.
    -s, --store [path]        Folder were uploads are stored. Defaults to cwd.
    -u, --uploadRoute [path]  Path of the upload route. Defaults to /upload.
    -m, --maxKb [kb]          Maximum file size in kilobytes. Defaults to 5120 KB.
    --image-processing [config file]  Process uploaded images. Supply path to config file for processing.
    -h, --help                output usage information

Example

Run at 127.0.0.1, port 1337, save uploads in ~/some/path. Upload url is http://127.0.0.1/uploadHere and the maximal accepted file size is 10240kb (10MB).

upload-test-server start -h 127.0.0.1 -p 1337 -s ~/some/path -u /uploadHere -m 10240

Image processing

The server can resize jpg and png files and/or generate multiple thumbnails.
In order to process images you need to provide a simple config file in json format.

The server currently only processes jpg and png files.

upload-test-server start --image-processing ./config.json

{
  "resize": {
    "maxWidth": 480,
    "maxHeight": 320
  },
  "thumbnails": [ 5, 100, 250, 500 ],
  "meta": true
}

resize

Resize the uploaded image to fit into the boundaries of

• maxWidth pixels and
• maxHeight pixels

thumbnails

An array pixel values for maximum height. The server creates a subdirectory for each size and saves the generated thumbnails with the same name as the full size image.

Example

{
  "thumbnails": [ 5, 100 ]
}

The server creates the following folder structure and files for each uploaded image:

/upload/my-image.jpg # Full size image
/upload/5/my-image.jpg # Image with height of 5 pixel and the correct pixels in with to keep ratio.
/upload/100/my-image.jpg # Image with height of 100 pixel and the correct pixels in with to keep ratio.

meta

If true then the server response includes meta data for images, like this.

{
  "channels": 3,
  "depth": "uchar",
  "format": "jpeg",
  "hasAlpha": false,
  "hasProfile": false,
  "width": 427,
  "height": 320,
  "space": "srgb"
}