vue-starter

an enterprise ready boilerplate for isomorphic, progressive web apps

Live demo

If you want to see a preview before you decide for this starter, please visit the vue-starter app on heroku!

Features

Quick scaffolding

Create components, connected components, modules - and their tests - right from the CLI!

Instant feedback

Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the CSS and TypeScript are reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!

SEO (with vue-meta)

We support SEO (document head tags management) and server-side-rendering for search engines that support indexing of JavaScript content. (eg. Google)

Progressive-Web-App

Offline-first support with service-workers and a lighthouse score as high as possible (for me - 90+).

Enterprise ready

Common style guide, TypeScript and the best test setup: Automatically guarantee code quality and non-breaking changes.

Animations (with anime.js)

A stable animations set up already included.

Components

A flexible component library that'll be extended over time.

Industry-standard i18n internationalization support

Scalable apps need to support multiple languages, easily add and support multiple languages with vue-i18n.

Predictable state management

With vuex.

Routing with data prefetching

Server-side-rendering of prefetched data and transferring state from server to client.

Quick start

1. Install Node.js 8.7.x or higher. Use nvm to maintain multiple Node.js versions
2. Install npm version 5.4.x or higher
3. clone repository git clone https://github.com/devCrossNet/vue-starter
4. Install dependencies: npm install
5. Run npm run dev. The server runs on port 3000 by default, set PORT environment variable to configure a different port

Documentation

WIP

Run unit tests

• npm test runs tests once
• npm run test:coverage runs tests with coverage once

Find a detailed coverage report in coverage/iconv-report/index.html

Generators

This boilerplate comes with the possibility to generate modules, components and connected components to keep a common style guide and to make development faster.

To generate code just run npm run generate or npm run g and follow the instructions.

Release

To release a new version of your project run one of the following commands:

• npm run release:major
• npm run release:minor
• npm run release:patch

This will also automatically generate a change log.

Reference resources

• React Boilerplate
• vue-ssr-starter-kit
• Angular

License

MIT