@stexcore/live-server NPM

@stexcore/live-server

NPM Version License

Live Server is a CLI tool designed to streamline local development by enabling real-time updates and quick testing of static files with minimal setup.

🚀 Features

Real-Time Updates: Automatically refreshes the browser whenever files change to ensure you’re always viewing the latest version.
Quick Server Initialization: Start serving your files instantly from the command line.
Multi-Directory Support: Serve static files from multiple directories seamlessly.
Automatic File Detection: Handles common scenarios like missing index.html files gracefully.
Dynamic Browser Interaction: Injects functionality into served files for enhanced debugging and development convenience.

🛠️ Installation

To use Live Server, install it globally via npm:

npm install -g @stexcore/live-server

📝 Usage

Start a development server from the command line:

live-server \[paths...\] \[options\]

Examples

Serve a directory (defaults to index.html if present):
```
live-server ./public
```
Serve the current directory:
```
live-server .
```
Or simply:
```
live-server
```
Customize the port (default: 3000):
```
live-server ./public --port 8080
```
View available commands and options:
```
live-server --help
```
Show the current version of Live Server:
```
live-server --version
```
Or:
```
live-server -v
```
Enable strict mode (enforce exact matching of paths):
```
live-server ./public --strict
```
Or:
```
live-server ./public -s
```

Real-Time Functionality

Live Server makes development seamless by providing:

Automatic Refresh: Detects changes in your project and instantly refreshes the browser.
Robust Connectivity: Keeps the client connected to the server, ensuring uninterrupted updates.

Directory Structure

The CLI expects a directory or file path to serve. Example:

project-root/
├── public/
│   ├── index.html
│   ├── styles.css
│   ├── app.js
│   ├── images/
│   │   ├── logo.png
│   │   └── banner.jpg

Available CLI Options

Option	Description	Default
`paths`	One or more directories or files to serve.	Current working directory
`--port=<number>`	Specify the port for the server.	`3000`
`-p <number>`	Alias for `--port`.	-
`--help, -h`	Show this help message.	-
`--version, -v`	Show the current version.	-
`--strict, -s`	Enforce exact matching between the requested path and filename.	`false`

🤝 Contributing

We welcome contributions to improve Live Server! If you find bugs, want to propose new features, or enhance the CLI experience, feel free to open an issue or submit a pull request.

📄 License

This project is licensed under the MIT License.

✨ Author

Developed with ❤️ by Stexcore.

live server realtime html static

colors express mime-types morgan ws

1.0.0-beta.1

3 months ago

1.0.0-alpha.1

3 months ago