Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 4.35 KB

README.md

File metadata and controls

80 lines (51 loc) · 4.35 KB
Raw

vue-starter

A Vue.js starter kit that lets you focus on more programming and less configuration.

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

This template is Vue 2.0 compatible.

Why?

At Scroll.in, we have chosen Vue.js as our primary JS framework. So, while working on various Vue.js projects we felt like we needed a template for all our projects which can be used for better consistency and coding style across developers.

We could always use the in built templates that come with vue-cli, but somehow I felt webpack-simple was too simple and lacked certain necessary features to be opted as a standard boilerplate for our projects. On the other hand, webpack seemed too complex to understand what's going on inside it specially for a junior dev it would be nightmare to make some config changes to it.

This is why this project came to life. With certain decisions already made to make life easier for programmers and certain feature built in right out of the box.

This project started as a webpack-simple template with incremental addition of features and configs to suit the needs of a medium to large vue.js project. It is inspired by the webpack template but without all the complexity.

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 rohitkrai03/vue-starter 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.
    • Use npm run build --reportto build with bundle size analytics.

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

  • This boilerplate uses ESLint as the linter, and uses the eslint-config-airbnb preset with some small customizations.

  • Option to install and setup vue-router

  • Utilities like lodash and axios come installed out of the box. You can opt out while installing template from vue-cli as well. Also, webpack will be configured accordingly to make use of only the modules that are used and not the whole library to reduce bundle size.

  • An option to install a UI Library

    • Element A Vue 2.0 based component library for developers, designers and product managers. Also, configured to use only the required modules and components in the final bundle.
    • Foundation A responsive front-end framework. Imported minified css file in index.html. Js file can be imported as per the need as well.

  • A converge like config management system which merges different config files based on environment and app mode.

  • A well defined folder structure for medium to large Vue.js projects.

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