servekaro v0.2.1

Serve Karo

Ap ek application ho, to serve karo!

Serve Karo is a configurable static web server that you can deploy to production environments! With Serve Karo, you don't have to write your own webserver, simply install the package and type:

$ servekaro

That's it!

Usage

First, install the package.

$ npm install --save servekaro

Usually, you'd use Serve Karo in a production environment, so use --save instead of --save-dev.

Configuring Serve Karo

Serve Karo is configured by a servekaro.json file in the project directory.

{
    "port": "80",
    "host": "0.0.0.0",
    "serving": "public",
    "root": "index.html",
    "notFound": "404.html"
}

The properties that can be set are as follows:

The 'notFound' property

Specifying a filename for the notFound property will serve the given file with a status of 404.

{
    "notFound": "404.html"
}

You can also specify an object for the notFound property containing a file property (the filename to send) and a status property (the status of the object). For example (if you have an app which handles routing on client-side) you can configure the notFound property like so:

{
    "notFound": {
        "file": "index.html",
        "status": "200"
    }
}

If the notFound property is not set, the server will return the default 404 File not found! message.

Environment variables

The host and port properties can be configured from environment variables! The format is as follows:

{
    "host": {
        "env": "HOST",
        "default": "0.0.0.0"
    },
    "port": {
        "env": "PORT",
        "default": 80
    }
}

Be sure to add the default parameter to ensure that the server can run if the environment variable is not configured.

Starting the server

Simply type

$ servekaro

And your website will serve the configured serving directory on the configured host and port.

Anshul Kharbanda 2018