Skip to content
More options for VueJS webpack official template: TypeScript, Library, Class-Style components ...
Branch: develop
Clone or download
Pull request Compare This branch is 132 commits ahead, 7 commits behind vuejs-templates:develop.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Merge branch 'develop-upstream' into develop Jan 29, 2018
docs Merge branch 'develop-upstream' into develop Jan 15, 2018
lib Bring back Single File Components by default (option) Jan 10, 2018
scenarios Merge branch 'develop-upstream' into develop Jan 29, 2018
template Remove .vue extensions in TypeScript imports Feb 6, 2018
utils Merge branch 'develop-upstream' into develop Jan 15, 2018
.gitignore Merge branch 'develop-upstream' into develop Jan 15, 2018
LICENSE Create LICENSE (vuejs-templates#942) Sep 30, 2017
README.md Add circleci badge Jan 15, 2018
deploy-docs.sh Update docs and tools with fork Mar 17, 2017
meta.js Merge branch 'develop-upstream' into develop Jan 29, 2018
metalsmith.js
package-lock.json add eslint-plugin-vue Jan 2, 2018
package.json Merge branch 'develop-upstream' into develop Jan 15, 2018

README.md

vue-webpack-boilerplate Build Status

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

This template is Vue 2.0 compatible.

This is a fork of official webpack template that brings more options, like TypeScript, Library, Class-Style components ...

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 Toilal/vue-webpack-template my-project
$ cd my-project
$ npm install
$ npm run dev

This will scaffold the project using the master branch. If you wish to use the latest version of the webpack template, do the following instead:

$ vue init webpack#develop my-project

⚠️ The develop branch is not considered stable and can contain bugs or not build at all, so use at your own risk.

The development server will run on port 8080 by default. If that port is already in use on your machine, the next free port will be used.

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 v3.
    • HTML minified with html-minifier.
    • CSS across all components extracted into a single file and minified with cssnano.
    • Static assets compiled with version hashes for efficient long-term caching, and an auto-generated production index.html with proper URLs to these generated assets.
    • Use npm run build --reportto build with bundle size analytics.
  • npm run unit: Unit tests run in JSDOM with Jest, or in PhantomJS with Karma + Mocha + karma-webpack.

    • Supports ES2015+ in test files.
    • Easy mocking.
  • 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.

Fork It And Make Your Own

You can fork this repo to create your own boilerplate, and use it with vue-cli:

vue init username/repo my-project
You can’t perform that action at this time.