/vue-webpack-template

A full-featured Webpack + vue-template-loader setup with hot reload, linting, testing & css extraction.

Primary LanguageJavaScriptMIT LicenseMIT

vue-webpack-template 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. It adds a TypeScript option and allow building components with standard .js/.ts files using external .css and .html files. Developer still benefit of Hot Module Reload and scoped CSS though.

It also adds a Library option to build and distribute a vue component only. In this case, an application is still used for development, but it won't be packaged in the distribution.

Why using this fork ?

You should really consider using this fork if ...

  • You have issues with .vue files in your favorite code editor.
  • You want to stick to pure .js/.ts files for some reason.
  • You don't want to put HTML, CSS & Script in a single file.
  • You want to build and distribute a vue component instead of a whole application.

Known issues with .vue files and TypeScript

  • Intellij IDEA (and probably others) can't resolve TypeScript modules coming from .vue files, making navigation in a vue project really painfull.
  • tslint doesn't support .vue files.

Despite those issues exists, you can still import .vue Single Files Components with this boilerplate from your own code or dependency.

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

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-template-loader + vue-hot-reload-loader for 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.
    • 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