Repository files navigation

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

Including Vue-component-class, Vuex, Vue-router and localisation

• 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

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

$ npm install -g vue-cli$ vue init twcapps/vue-typescript-boilerplate my-project$cd my-project$ npm install$ npm run dev

This will scaffold the project using themaster 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.

• 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 TSLint
  • Source maps

• npm run build: Production ready build.

  • JavaScript minified withUglifyJS v3.
  • HTML minified withhtml-minifier.
  • CSS across all components extracted into a single file and minified withcssnano.
  • Static assets compiled with version hashes for efficient long-term caching, and an auto-generated productionindex.html with proper URLs to these generated assets.
  • Usenpm run build --reportto build with bundle size analytics.

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

  • Supports ES2015+ in test files.
  • Easy mocking.

• npm run e2e: End-to-end tests withNightwatch.

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

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

vue init username/repo my-project