Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.43 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.43 KB
Raw

node-autostatic-server

autostatic-server is a node application running on command line interface (CLI).

It provides a handy 'portable' static node server. It is almost usefull to serve any folder wich you want to serve during your daily development works.

You can run as much autostatic server instances as you need in the same time. Just, don't forget to specify a different port for each one thanks to -p or --port CLI option. For example:

// serve current directory on port 8080
$ autostatic
// serve user $HOME directory on port 1024
$ autostatic --dir ~/ --port 1024
// serve current directory on port 3000
$ autostatic --dir /var/www --port 3000

// etc ...

Example

You just discover the beautiful "Wall Clock Pure CSS3" on github.

So to lauch the demo, you just have to run autostatic after having downloaded the files:

$ git clone https://github.com/rassadin/css3-experiments.git
$ cd css3-experiments
$ autostatic

Automatically, your favorite browser opens to http://localhost:8080/ where the files are served so you enjoy instantly your fresh demo.

Installation

$ [sudo] npm -g install autostatic-server

Usage

$ autostatic

will serve instantly the current directory in your default browser on port 8080

$ autostatic --version

will display the autostatic-server version

$ autostatic --help

will show you the options also listed bellow.

Options

Usage: autostatic [options]

Options:

  -h, --help                   output usage information
  -V, --version                output the version number
  -d --dir <directory>         directory to serve (default: .)
  -b --browser <browser name>  browser which open served directory
  -h --hide-dotted             hide dotted files (default: false)
  -p --port <port>             http port to serve to (default: 8080)
  -r --remote                  don't automatically lauch browser on  localhost (useful if running on remote host)
  -s --stop-on-close           automatically stop the server when user close the browser
  -c --cors                    enable Cross-Origin-Resource-Sharing for all served static files

Note:

If you don't specify a port with -p or --port option, autostatic will search your $PORT environement variable to serve on it. Else, the files will be served on the default port: 8080