vue-component-boilerplate

A full-featured Webpack setup with hot-reload, lint-on-save, unit testing & css extraction.

For reusable components

Version Notice

This template is using [email protected], which provides more configurable options.

Documentation

This is a fork of webpack template. Make sure to read it!, template docs too.

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 wovue/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 build: Production ready build.

  • JavaScript minified with UglifyJS.
  • HTML minified with html-minifier.
  • CSS across all components extracted into a single file and minified with cssnano.
  • All static assets compiled with version hashes for efficient long-term caching, and a production index.html is auto-generated with proper URLs to these generated assets.

• npm run deploy-docs: Deploy to gh-pages from docs folder.

• 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.

Template documentation

Folders

• src-docs: docs source files for deploy to gh-pages

• src: component source files

src-docs structure

.
├── index.html                # index.html template for HtmlWebpackPlugin
├── app/                      
│   ├── main.js               # docs webpack entry file
│   ├── components/           # ui components in root level
│   ├── config                # vue global config
│   ├── pages                 # pages components
│   ├── shared                # global modules
│   └── snippets              # code to highlight
├── assets/                   # module assets (processed by webpack)
└── styles/                   # docs sass styles

I have updated the repository name

You have to update prod.docs.assetsPublicPath value in config/index.js