Introduction

Shrub is based on Bourgeon.

This boilerplate is targeted towards large, serious projects and assumes you are somewhat familiar with Webpack and vue-loader. Make sure to also read vue-loader's documentation for common workflow recipes.

If you just want to try out vue-loader or whip out a quick prototype, use the webpack-simple template instead.

What's different

This template is a fork of the official webpack template. A few more opinionated features and conventions are bundled with Shrub:

• VueX installed and ready to use
• Routing using official vue-router and conventions
• i18n using vue-i18n, yaml-loader and conventions
• Store using vuex or a simple convention for sharing data between components
• SVG Sprites using svg-sprite-loader and conventions
• Stylus using stylus-loader and some custom mixins

Soon

• Preloader using resource-loader and conventions

Quickstart

To use this template, scaffold a project with vue-cli. It is recommended to use npm 3+ for a more efficient dependency tree.

$ npm install -g vue-cli
$ vue init webpack my-project
$ cd my-project
$ npm install
$ npm run dev

Configuration

Shrub favors convention over configuration. But some configuration can be passed in the plugin call:

// main.js
Vue.use(Shrub, {
  locales: ['fr', 'en']
})