# serve-dev

> A very simple but highly customizable server for local web development

Latest version **1.0.0-alpha.6** (published 2020-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install serve-dev
pnpm add serve-dev
yarn add serve-dev
bun add serve-dev
```

## 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.0-alpha.6 |
| Published | 2020-07-05 |
| First published | 2020-07-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >13 |
| Dependencies | 8 |
| Unpacked size | 6.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Koen Vendrik |
| Maintainers | kvendrik |

## Links

- npm: https://www.npmjs.com/package/serve-dev
- npm.io page: https://npm.io/package/serve-dev

## Dependencies (8)

- [koa](https://npm.io/package/koa.md) ^2.13.0
- [open](https://npm.io/package/open.md) ^7.0.4
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [koa-send](https://npm.io/package/koa-send.md) ^5.0.0
- [koa-router](https://npm.io/package/koa-router.md) ^9.1.0
- [koa-static](https://npm.io/package/koa-static.md) ^5.0.0
- [node-watch](https://npm.io/package/node-watch.md) ^0.6.4
- [koa-websocket](https://npm.io/package/koa-websocket.md) ^6.0.0

## Recent versions

- 1.0.0-alpha.6 (latest) — 2020-07-05
- 1.0.0-alpha.5 — 2020-07-05
- 1.0.0-alpha.4 — 2020-07-05
- 1.0.0-alpha.3 — 2020-07-05
- 1.0.0-alpha.1 — 2020-07-05

## README

# serve-dev

🏗️ A very simple but highly customizable server for local web development

- 👀 Watch source files
- 🔁 Live reload when changes occur
- 🏃‍♂️ Quick to set up
- 💪 Unopinionated about how source files get compiled

## Setup

```bash
yarn add --dev serve-dev
```

```tsx
// server.mjs
// node server.mjs (Node v13+)

import DevServer from 'serve-dev';

new DevServer({
  root: 'public',
  port: 9000,
  watch: {
    paths: ['src'],
    onChange(filePath) {
      console.log(`${filePath} changed.`);
      return {shouldReloadPage: true};
    }
  },
}).start()
```

Check out [`example/server.mjs`](https://github.com/kvendrik/serve-dev/blob/master/example/server.mjs) for a more advanced example.

## Contribute

Make your changes and run `yarn example` to test them using the example setup.

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