jmjuanes/stattic

Ridiculous simple script for serving static files.

stattic

Ridiculous simple script for serving static files using http module.

Installation

Install it using NPM:

npm install stattic --save

Usage

Example of a very simple server that shows all the static files on the public folder:

//Import stattic
let stattic = require("stattic");

//Run the web server
stattic({
    "folder": "./public",
    "port": 5000
});

API

stattic(options)

Starts a new server with the configuration specified in the options object. The following table lists the available options:

key	Description	Type	Default value
folder	Sets the path of your static files folder.	String	./
port	Sets the port of your server.	Integer	5000
cors	Enable cross-origin resource sharing (CORS).	Boolean	false
index	Sets the index file name.	String	index.html

CLI usage

You can install the CLI by running the following command:

npm install -g stattic

Now you can navigate to a folder with your static files and initialize a static server:

cd /path/to/your/static/content/
stattic --port 5000 --cors

This will start a new static server in the port 5000 that will serve all files placed in the current folder.

CLI options

--port PORT

Specify the port for your static server. Default is 5000.

--folder FOLDER

You can specify a different folder to serve the static files. Example

stattic --port 5000 --folder /path/to/your/static/content/

--cors

Use this option to enable cors.

License

MIT LICENSE © Josemi Juanes.

stattic's Issues

Security issue

Hi,

I'm a member of the Node.js Security WG and we received a report regarding a security issue with this module.

We tried inviting the author by e-mail but received no response so I'm opening this issue and inviting anyone with commit and npm publish rights to collaborate with us on a fix.

Fix static files path

> [email protected] test /Users/jmjuanes/git/coverviewer-dev
> node dev.js


Welcome to Stattic
Visit us: http://statticjs.github.io

Static server listening on: http://localhost:5001
Static files listening from: /Users/jmjuanes/git/coverviewer-dev/node_modules/coverviewer-build

Requests to block

All the requests that aren't GET requests should be blocked.