https://github.com/gluons/vue-dev-server

A simple dev server for @vuejs.
https://github.com/gluons/vue-dev-server

dev-server hacktoberfest vue vuejs

Last synced: 5 months ago
JSON representation

A simple dev server for @vuejs.

• Host: GitHub
• URL: https://github.com/gluons/vue-dev-server
• Owner: gluons
• License: mit
• Created: 2020-08-11T02:57:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-08-13T22:03:42.000Z (6 months ago)
• Last Synced: 2025-08-17T06:49:31.467Z (5 months ago)
• Topics: dev-server, hacktoberfest, vue, vuejs
• Language: TypeScript
• Homepage: https://npm.im/@gluons/vue-dev-server
• Size: 346 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Vue Dev Server

[![GitHub](https://img.shields.io/github/license/gluons/vue-dev-server?style=flat-square)](./LICENSE)

[![npm](https://img.shields.io/npm/v/@gluons/vue-dev-server?style=flat-square)](https://www.npmjs.com/package/@gluons/vue-dev-server)

![GitHub top language](https://img.shields.io/github/languages/top/gluons/vue-dev-server?style=flat-square)

[![Codacy branch grade](https://img.shields.io/codacy/grade/29cc5dc9c8ac4f5ca3ded76a0feda5ae/master?style=flat-square)](https://www.codacy.com/manual/gluons/vue-dev-server)

[![Travis (.com)](https://img.shields.io/travis/com/gluons/vue-dev-server?style=flat-square)](https://travis-ci.com/github/gluons/vue-dev-server)

A simple dev server for [Vue.js](https://vuejs.org/).

## Installation

**Via [npm](https://www.npmjs.com/):**

```bash

npm install -D @gluons/vue-dev-server

```

**Via [pnpm](https://pnpm.js.org/):**

```bash

pnpm install -D @gluons/vue-dev-server

```

**Via [Yarn](https://yarnpkg.com/):**

```basn

yarn add -D @gluons/vue-dev-server

```

## Usage

**CLI:**

```bash

vue-dev-server main.ts

```

Use `vue-dev-server -h` for help.

## Config

Config file will be loaded by [Cosmiconfig](https://github.com/davidtheclark/cosmiconfig).

Config file can be the file below:

- `vue-dev-server.config.js`

- `vue-dev-server.config.json`

- `vue-dev-server.config.yaml`

- `vue-dev-server.config.yml`

- `vue-dev-server.config.ts`

---

### entry

**Type:** `string`  

**Required:** ✔

Path to entry file.

### alias

**Type:** `Record`

Path aliases.

### define

**Type:** `Record`  

**Default:** `{ 'process.env.NODE_ENV': 'development' }`

Define global constants which can be configured at compile time.

### port

**Type:** `number`  

**Default:** `8080`

Port of development server.

### open

**Type:** `boolean`  

**Default:** `true`

Open webpage in browser when server start.

### clipboard

**Type:** `boolean`  

**Default:** `false`

Copy dev server URL to clipboard.

### htmlTitle

**Type:** `string`  

**Default:** `'Vue Dev Server'`

Title of development webpage.