https://github.com/jmjuanes/stattic

Ridiculous simple script for serving static files.
https://github.com/jmjuanes/stattic

nodejs-server static static-files static-server static-site

Last synced: 10 days ago
JSON representation

Ridiculous simple script for serving static files.

• Host: GitHub
• URL: https://github.com/jmjuanes/stattic
• Owner: jmjuanes
• License: mit
• Created: 2015-12-15T16:07:31.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-05-18T23:53:46.000Z (over 5 years ago)
• Last Synced: 2024-10-18T02:42:34.511Z (18 days ago)
• Topics: nodejs-server, static, static-files, static-server, static-site
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/stattic
• Size: 37.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# stattic

[![npm](https://img.shields.io/npm/v/stattic.svg?style=flat-square)](https://www.npmjs.com/package/stattic)

[![npm](https://img.shields.io/npm/dt/stattic.svg?style=flat-square)](https://www.npmjs.com/package/stattic)

[![Dependency Status](https://david-dm.org/statticjs/stattic.svg?style=flat-square)](https://david-dm.org/statticjs/stattic)

[![npm](https://img.shields.io/npm/l/stattic.svg?style=flat-square)](https://github.com/jmjuanes/stattic)

Ridiculous simple script for serving static files using `http` module.

## Installation

Install it using NPM:

```sh

npm install stattic --save

```

## Usage

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

```javascript

//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](./LICENSE) © Josemi Juanes.