hotweby

Simple hot-reloading webserver based on express, a recursive fs watcher, a websocket endpoint and a html injected javascript function.

• hotweby
• Getting started
  • Run
  • Options
  • Run as webserver
• Contributing
• License
• Disclaimer

Getting started

Run

npx hotweby --help

or

bun x hotweby --help

Options

Usage: hotweby [options]

Automatic hot-reloading webserver using websockets

Options:
  -V, --version                    output the version number
  -p, --port <number>              hot reload server port
                                   (default: 8080, env: SERVE_PORT)
  -d, --dir <string>               Directory to serve html and other static files from.
                                   (default: ".", env: SERVE_PATH)
  -a, --auto-extension-resolution  Try to auto default missing request file extensions. Checks if the requested dir
                                   containing a filename starting with requested name + '.'
                                   (default: false, env: SERVE_AUTO_EXTENSION_RESOLUTION)
  -h, --help                       display help for command

Run as webserver

Running a server on port 8080 watching and serving current dir

npx hotweby

Running a server on port 3000 watching and serving html with extension resolution

npx hotweby -p 3000 -d html -a

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.