servir v1.0.3

Servir

This is an ExpressJs based server to host static files and single page application on production. It provides the options to create and rotate logs as well as enforce https redirection.

Its build using the following modules

• ExpressJs
• Winston
• Express winston
• Minimist
• Command line Usage
• Path

Commands

This apps works by running serve [directory] [options] the options are provided belows

Options

• --logstash, -l : Instructs creation of logs formated for logstash, default false
• --logsDir, -d : Specifies the folder to place logs, default logs
• --app, a : Specifies the name of the application, used to name logs files, default combined
• --secure, -s : Specifies whether we should enforce https redirection default false.
• --port, -p : Specifies the port to start server at. Default 4040
• --rotate, -r : Instructs rotation of logs, default true

Environment variables for options

• PUBLIC_DIR : specifies the directory static files should be served from
• ENABLE_LOGSTASH : Specifies the folder to place logs, default logs
• LOGS_DIR : Specifies the folder to place logs, default logs
• APP_NAME : Specifies the name of the application, used to name logs files, default combined
• HTTPS : Specifies whether we should enforce https redirection default false.
• PORT : Specifies the port to start server at. Default 4040
• ROTATE_LOGS : Instructs rotation of logs, default true

Testing

Manual testing, clone this repository and link the application by running npm link on the root directory. You should be able to have serve binary on your machine. Run serve with the above commands.

Note: This docs are bound to change.