vue-component-template

A full-featured Webpack setup with hot-reload, lint-on-save, unit testing & css extraction for open source Vue components.

Based on the official vue-webpack-boilerplate template

This template is Vue 2.0 compatible.

Documentation

• For this template: common questions specific to this template are answered and each part is described in greater detail
• For Vue 2.0: general information about how to work with Vue, not specific to this template

Usage

This is a project template for vue-cli. It is recommended to use npm 3+ for a more efficient dependency tree.

$ npm install -g vue-cli
$ vue init monterail/vue-component-template my-project
$ cd my-project
$ npm install
$ npm run dev

What's Included

• npm run dev: first-in-class development experience.

  • Webpack + vue-loader for single file Vue components.
  • State preserving hot-reload
  • State preserving compilation error overlay
  • Lint-on-save with ESLint
  • Source maps

• npm run bundle: Create UMD bundle.

• npm run docs: Create docs inside /gh-pages ready to be published

• npm run unit: Unit tests run in PhantomJS with Karma + Mocha + karma-webpack.

  • Supports ES2015 in test files.
  • Supports all webpack loaders.
  • Easy mock injection.

• npm run e2e: End-to-end tests with Nightwatch.

  • Run tests in multiple browsers in parallel.
  • Works with one command out of the box:
    • Selenium and chromedriver dependencies automatically handled.
    • Automatically spawns the Selenium server.