https://github.com/seldszar/stug
Simple web server broadcasting file changes through WebSocket.
https://github.com/seldszar/stug
filesystem watcher webserver websocket
Last synced: 2 months ago
JSON representation
Simple web server broadcasting file changes through WebSocket.
- Host: GitHub
- URL: https://github.com/seldszar/stug
- Owner: Seldszar
- License: mit
- Created: 2018-06-24T15:13:13.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-29T23:16:30.000Z (almost 8 years ago)
- Last Synced: 2025-03-11T09:53:29.591Z (over 1 year ago)
- Topics: filesystem, watcher, webserver, websocket
- Language: JavaScript
- Size: 71.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stug
> Firing a sticky, toxic, explosive compound, the Stug Gel Gun offers multiple ejection modes, delivering maximum damage in all situations.
Simple web server broadcasting file changes through WebSocket.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Author](#author)
- [License](#license)
## Prerequisites
- [Node.js](https://nodejs.org)
## Installation
```bash
npm install seldszar/stug --global
```
## Usage
### By using default options
Open a command terminal in the folder you want to use then type the following command.
```bash
$ stug
```
### By using a custom folder
Instead of going to the folder you want to use, you can tell the program to use another one by using the `base` option.
```bash
$ stug --base=
```
### By using a custom host and/or port
If for some reasons you want to change the host and/or port, you can customize by using the `host` and `port` options.
```bash
$ stug --host= --port=
```
## Author
Alexandre Breteau - [@0xSeldszar](https://twitter.com/0xSeldszar)
## License
MIT © [Alexandre Breteau](https://seldszar.fr)