webserve 1.0.6

A lightweight web server
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
99

<div align="center">
  <h1> webserve </h1>
</div>

<p align="center">
  <img src="https://img.shields.io/github/stars/marcuwynu23/webserve.svg" alt="Stars Badge"/>
  <img src="https://img.shields.io/github/forks/marcuwynu23/webserve.svg" alt="Forks Badge"/>
  <img src="https://img.shields.io/github/issues/marcuwynu23/webserve.svg" alt="Issues Badge"/>
  <img src="https://img.shields.io/github/license/marcuwynu23/webserve.svg" alt="License Badge"/>
</p>

A blazing-fast static file and SPA Web server written in **Rust**, powered by [`warp`](https://crates.io/crates/warp). Supports **live reload**, SPA fallback, and directory serving — like `npm serve`, but compiled and production-ready.

---

## 🚀 Features

- ✅ Serve any directory (`-d ./dist`)
- ✅ SPA fallback support (`--spa`)
- ✅ File watching with automatic browser reload (`--watch`)
- ✅ Configurable host and port (`-h`, `-p`)
- ✅ Built with Rust + Tokio for high performance

---

## 📦 Installation

```bash
git clone https://github.com/your-username/webserve
cd webserve
cargo build --release
```

The executable will be located in `target/release/webserve`.

You can also install it globally (requires Rust):

```bash
cargo install --path .
```

---

## 🛠 Usage

```bash
webserve [OPTIONS]
```

### Options

| Flag            | Description                            | Default           |
| --------------- | -------------------------------------- | ----------------- |
| `-d`, `--dir`   | Directory to serve files from          | Current directory |
| `-p`, `--port`  | Port to listen on                      | `8080`            |
| `-h`, `--host`  | Host/IP to bind                        | `127.0.0.1`       |
| `--spa`         | Enable SPA fallback (404 → index.html) | disabled          |
| `-w`, `--watch` | Enable file watching + auto-reload     | disabled          |

---

## 🧪 Example

Serve a Vite/React app from `./dist`, with SPA fallback and live reload:

```bash
webserve -d ./dist --spa --watch
```

---

## 💻 Injected Reload Script

When `--watch` is used, `index.html` is automatically injected with:

```html
<script>
  const socket = new WebSocket(`ws://${location.host}/reload`);
  socket.onmessage = () => location.reload();
</script>
```

---

## 📁 Project Structure

```
webserve/
├── src/
│   └── main.rs         # Web server logic
├── Cargo.toml          # Dependencies
└── README.md
```

---

## 📜 License

MIT © Mark Wayne Menorca