Deprecated: Since vue-cli v3.0 is out, there is no interest in keeping this repository alive, since all of bourgeon setup is now available natively. Therefore, this repository is now deprecated. Thanks you all for this adventure.

bourgeon

Bourgeon is an opinionated-featured VueJS 2.0 setup for Webpack

The setup includes hot-reload, lint-on-save, unit testing, css extraction, vuex, advanced routing, i18n, SVG sprite sheets and stylus with some helpers. Almost everything is optional and you can select which sugars you want on init

What's different

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

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

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 rayfranco/bourgeon my-project
$ cd my-project
$ npm install
$ npm run dev

What's Included

• 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

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

• npm run unit: Unit tests run in PhantomJS with Karma + Mocha + 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.

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