Skip to content

Latest commit

 

History

History
67 lines (52 loc) · 3.04 KB

README.md

File metadata and controls

67 lines (52 loc) · 3.04 KB
Raw

hotweby

CI/CD MIT typescript npm

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

Getting started

Global install

npm i 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 this project 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

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

Disclaimer

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