README.md

vue-webpack-boilerplate

WIP

What's Included

• npm run dev: Webpack + vue-loader with proper config for hot-reload, source maps, and lint-on-save with ESLint.

• npm run build: Production ready build with HTML/CSS/JS minification and CSS extracted into a single file.

• npm test: Unit tests in PhantomJS with Karma + karma-jasmine + karma-webpack, supporting all webpack loaders, mock injection and ES2015.

For detailed explanation on how things work, consult the docs for vue-loader.

Customizations

You will likely need to do some tuning to suit your own needs:

• Install additional libraries that you need, e.g. vue-router, vue-resource, vuex, etc...

• Use your preferred .eslintrc config.

• Add your preferred CSS pre-processor, for example:

  npm install less-loader --save-dev

• In build/webpack.base.conf.js:

  • Adjust output.path if you want the built file to be generated at a different location.

  • Add devServer.proxy field if you want to work with an existing backend server. See docs for webpack dev server proxy.

• For unit testing:

  • You can run the tests in multiple real browsers by installing more karma launchers and adjusting the browsers field in build/karma.conf.js.

  • You can also swap out Jasmine for other testing frameworks, e.g. use Mocha with karma-mocha.

Fork It And Make Your Own

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

khaos create username/repo my-project