https://github.com/marcuwynu23/webserve
A blazing-fast static file and SPA Web server
https://github.com/marcuwynu23/webserve
Last synced: 17 days ago
JSON representation
A blazing-fast static file and SPA Web server
- Host: GitHub
- URL: https://github.com/marcuwynu23/webserve
- Owner: marcuwynu23
- Created: 2025-04-11T05:36:32.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-04-25T01:58:51.000Z (6 months ago)
- Last Synced: 2025-04-25T02:54:46.289Z (6 months ago)
- Language: Rust
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
webserve
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
const socket = new WebSocket(`ws://${location.host}/reload`);
socket.onmessage = () => location.reload();
```
---
## 📁 Project Structure
```
webserve/
├── src/
│ └── main.rs # Web server logic
├── Cargo.toml # Dependencies
└── README.md
```
---
## 📜 License
MIT © Mark Wayne Menorca