NobleMajo / hotweby

Automatic hot reloading webserver based on file watcher, websocket and id endpoint

hotweby

Automatic hot-reloading webserver based on a file watcher, a websocket server, a id endpoint and a html injected javascript function.

• hotweby
• Getting started
  • Global install
  • Show help
  • Run as webserver
• Contributing
• License
• Disclaimer

---

Getting started

Global install

npm i -g @noblemajo/hotweby

Show help

hotweby --help

Usage: hotweby [options]

Automatic multiway hot-reloading webserver

Options:
  -V, --version               output the version number
  -p, --port <number>         hot reload server port (env: SERVE_PORT)
  -d, --dir <string>          target dir (default: ".", env: SERVE_PATH)
  -i, --id-endpoint <string>  id endpoint (default: "/noblemajo-serve-id", env: SERVE_ID_ENDPOINT)
  -h, --help                  display help for command

Run as webserver

hotweby -p 8080 -d html

Contributing

Contributions to hotweby are welcome!
Interested users can refer to the guidelines provided in the CONTRIBUTING.md file to contribute to the project and help improve its functionality and features.

License

hotweby is licensed under the MIT license, providing users with flexibility and freedom to use and modify the software according to their needs.

Disclaimer

hotweby is provided without warranties.
Users are advised to review the accompanying license for more information on the terms of use and limitations of liability.