# @jcrz/local-server

> A development http server for serving static html, css, and js files locally across a network.

Latest version **1.0.5** (published 2024-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jcrz/local-server
pnpm add @jcrz/local-server
yarn add @jcrz/local-server
bun add @jcrz/local-server
```

Provides the command `localServer`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-03-03 |
| First published | 2024-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jazelle Cruz |
| Maintainers | jazzcruz |
| Keywords | html, css, js, server, web development, web, development, local-server, local, tool, http, utility, npm, front-end, cli, command-line, dev, node |

## Links

- npm: https://www.npmjs.com/package/@jcrz/local-server
- Repository: https://github.com/jazellecruz/localServer
- Homepage: https://github.com/jazellecruz/localServer#readme
- Issues: https://github.com/jazellecruz/localServer/issues
- npm.io page: https://npm.io/package/@jcrz/local-server

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.0.5 (latest) — 2024-03-03
- 1.0.4 — 2024-03-01
- 1.0.3 — 2024-02-28
- 1.0.2 — 2024-02-28
- 1.0.1 — 2024-02-28
- 1.0.0 — 2024-02-28

## README

# LocalServer 

[LocalServer](https://www.npmjs.com/package/@jcrz/local-server) is featherlight development HTTP server to serve your static files locally across your network.

* Allows your files to be accessed by any device on your network.
* Light and minimal as it does not rely on any dependencies.
* Provides a simple CLI and only requires minimal configuration, making it noob-friendly :). 
* Made purely with Node.js ;)

## Installation
You'll need Node.js and NPM for this.

```sh
npm i @jcrz/local-server
```

Note: *Make sure node is initialized.*

## Usage
```sh
localServer [params]
```
### Command line parameters:
* `--path=PORT` - the port you want to use. Default port is set to 8000.
* `--dir=PATH` - the name or path of the directory of your static files. Default dir root path is set to "." (**NOTE**: Do not start your path or name with a "/" or "\\").

### Example Usage

```
localServer --port=5000 --dir=client
```

## Contribution
Any contribution is welcome. Just kindly make a pull request. For major changes, please open an issue first to discuss what you would like to change.

---
_Source: https://npm.io/package/@jcrz/local-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._