# @dvrpc/demo

> Build, deploy, and test all in one command

Latest version **1.0.1** (published 2018-02-09) · CC0-1.0 license · 0 weekly downloads

## Install

```sh
npm install @dvrpc/demo
pnpm add @dvrpc/demo
yarn add @dvrpc/demo
bun add @dvrpc/demo
```

Provides the command `demo`.

## 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.1 |
| Published | 2018-02-09 |
| First published | 2017-12-05 |
| Weekly downloads | 0 |
| License | CC0-1.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jesse Strangfeld |
| Maintainers | dvrpc |

## Links

- npm: https://www.npmjs.com/package/@dvrpc/demo
- Repository: https://github.com/dvrpc/demo
- Homepage: https://github.com/dvrpc/demo#readme
- Issues: https://github.com/dvrpc/demo/issues
- npm.io page: https://npm.io/package/@dvrpc/demo

## Dependencies (4)

- [opn](https://npm.io/package/opn.md) ^5.2.0
- [yargs](https://npm.io/package/yargs.md) ^11.0.0
- [chokidar](https://npm.io/package/chokidar.md) ^2.0.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0

## Recent versions

- 1.0.1 (latest) — 2018-02-09
- 1.0.0 — 2018-02-09
- 0.5.2 — 2018-02-07
- 0.5.1 — 2017-12-15
- 0.5.0 — 2017-12-14
- 0.4.0 — 2017-12-14
- 0.3.0 — 2017-12-05
- 0.2.0 — 2017-12-05
- 0.1.4 — 2017-12-05

## README

# demo
Build, clean, deploy, and launch your app with one command

## Install
Run `npm i -g @dvrpc/demo`

## Use
1. Add `build` script to `package.json`
2. Run `demo` from your project root

## Configure
Create `demo.config.js` file in your project root
```js
module.exports = {
  srcDir: <string>,
  serverPath: <string>,
  serverRootUri: <string>,
  buildArgs: <string|Array>,
  projectName: <string>,
  clean: <boolean>
}
```
You can also use a JSON file (`demo.config.json`)

## CLI options
Options override settings defined in the configuration

`demo [<projectName> -s <srcDir> -d <serverPath> -u <serverRootUri> -b <buildArgs> --watch --disable-clean]` 

## Watch
All files in the project (except for the output directory) are watched and the command will run again.

`demo --watch`

## Disable clean step
Overwrite all built files, but do not remove other files from the server.

`demo --disable-clean`

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