UNPKG

hotweby

Version:

Automatic hot-reloading webserver using websockets

github.com/NobleMajo/hotweby

NobleMajo/hotweby

98 lines (70 loc) • 3.63 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# hotweby ![CI/CD](https://github.com/noblemajo/hotweby/actions/workflows/npm-publish.yml/badge.svg) ![MIT](https://img.shields.io/badge/license-MIT-blue.svg) ![typescript](https://img.shields.io/badge/dynamic/json?style=plastic&color=blue&label=Typescript&prefix=v&query=devDependencies.typescript&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fhotweby%2Fmain%2Fpackage.json) ![npm](https://img.shields.io/npm/v/hotweby.svg?style=plastic&logo=npm&color=red) <!-- ![github](https://img.shields.io/badge/dynamic/json?style=plastic&color=darkviolet&label=GitHub&prefix=v&query=version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fnoblemajo%2Fhotweby%2Fmain%2Fpackage.json) --> ![](https://img.shields.io/badge/dynamic/json?color=green&label=watchers&query=watchers&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) ![](https://img.shields.io/badge/dynamic/json?color=yellow&label=stars&query=stargazers_count&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) ![](https://img.shields.io/badge/dynamic/json?color=navy&label=forks&query=forks&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) <!-- ![](https://img.shields.io/badge/dynamic/json?color=darkred&label=open%20issues&query=open_issues&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) ![](https://img.shields.io/badge/dynamic/json?color=orange&label=subscribers&query=subscribers_count&suffix=x&url=https%3A%2F%2Fapi.github.com%2Frepos%2Fnoblemajo%2Fhotweby) --> Simple hot-reloading webserver based on express, a recursive fs watcher, a websocket endpoint and a html injected javascript function. - [hotweby](#hotweby) - [Getting started](#getting-started) - [Run](#run) - [Options](#options) - [Run as webserver](#run-as-webserver) - [Contributing](#contributing) - [License](#license) - [Disclaimer](#disclaimer) --- # Getting started ## Run ```sh npx hotweby --help ``` or ```sh bun x hotweby --help ``` ## Options ```js 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 ```sh npx hotweby ``` Running a server on port 3000 watching and serving html with extension resolution ```sh 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](CONTRIBUTING.md) file to contribute to the project and help improve its functionality and features. # License This project is licensed under the [MIT license](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.