https://github.com/rbecheras/node-autostatic-server

Automatic server for static files; serve instantly any folder for dev/working purposes (not for production!)
https://github.com/rbecheras/node-autostatic-server

Last synced: about 2 months ago
JSON representation

Automatic server for static files; serve instantly any folder for dev/working purposes (not for production!)

• Host: GitHub
• URL: https://github.com/rbecheras/node-autostatic-server
• Owner: rbecheras
• License: mit
• Created: 2015-08-18T13:36:02.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-18T10:42:00.000Z (over 8 years ago)
• Last Synced: 2024-10-11T23:29:53.422Z (3 months ago)
• Language: JavaScript
• Homepage: https://github.com/rbecheras/node-autostatic-server
• Size: 15.6 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/rassadin/css3-experiments).

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 to serve (default: .)

      -b --browser   browser which open served directory

      -h --hide-dotted             hide dotted files (default: false)

      -p --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`