A full-featured Webpack setup with hot-reload, lint-on-save, unit testing & css extraction.
This boilerplate is targeted towards large, serious projects and contains a lot of moving pieces. If you just want to try out vue-loader
or whip out a quick prototype, use the webpack-simple template instead.
This is a project template for vue-cli.
$ npm install -g vue-cli
$ vue init webpack my-project
$ cd my-project
$ npm install
$ npm run dev
.
├── build
│ ├── dev-server.js # development server script
│ ├── webpack.base.conf.js # shared base webpack config
│ ├── webpack.dev.conf.js # development webpack config
│ ├── webpack.prod.conf.js # production webpack config
│ └── ...
├── src
│ ├── main.js # app entry file
│ ├── App.vue # main app component
│ ├── components # ui components
│ │ └── ...
│ └── assets # module assets (processed by webpack)
│ └── ...
├── static # pure static assets (directly copied)
├── dist # built files ready for deploy
├── test
│ └── unit # unit tests
│ └── ...
│ └── e2e # e2e tests
│ └── ...
├── .babelrc # babel config
├── .eslintrc.js # eslint config
├── index.html # main html file
└── package.json # build scripts and dependencies
-
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
- Webpack +
-
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. - To serve built files, run an HTTP server inside
/dist
.
-
npm run unit
: Unit tests run in PhantomJS with Karma + Jasmine + 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.
For a better understanding of how things work, consult the docs for respective projects listed. In particular, Webpack and vue-loader.
-
Files inside
src/assets/
should be referenced via relative paths inside Vue component templates and styles. This allows them to be processed by webpack usingurl-loader
andfile-loader
before copied into/static
. This allows you to leverage features such as file naming with hashes for better caching and conditional base-64 inline-ing. You can even add image-optimizing loaders to automatically optimize these images during build.Files inside
static/
are copied directly without modification; they can be reference anywhere via root-relative paths that start with/static/
. This is an escape hatch when you want certain assets to completely bypass webpack. -
The project uses Standard code style via ESLint. You can override the rules in
.eslintrc.js
, for example allowing semicolons by adding"semi": [2, "always"]
.Alternatively you can use a different config altogether, for example eslint-config-airbnb. Install it and change the
"extends"
field in.eslintrc.js
. -
First, install the corresponding loader, e.g.:
npm install less-loader --save-dev
Then in your
*.vue
files, use<style lang="less">
. The CSS extraction has been pre-configured to work with most popular pre-processors.Note that
lang="sass"
assumes SASS's indented syntax; Uselang="scss"
if you want the CSS-superset syntax. -
You can edit
proxyTable
inbuild/dev-server.js
to proxy certain requests to your backend server. -
You can run the tests in multiple real browsers by installing more karma launchers and adjusting the
browsers
field intest/unit/karma.conf.js
. -
To configure which browsers to run the tests in, add an entry under "test_settings" in
test/e2e/nightwatch.conf.js
, and also the--env
flag intest/e2e/runner.js
. If you wish to configure remote testing on services like SauceLabs, you can either make the nightwatch config conditional based on environment variables, or use a separate config file altogether. Consult Nightwatch's docs for more details.
You can fork this repo to create your own boilerplate, and use it with vue-cli
:
vue init username/repo my-project