https://github.com/twcapps/vue-typescript-boilerplate
VueJs boilerplate using Typescript, Vuex and Vue Router
https://github.com/twcapps/vue-typescript-boilerplate
Last synced: 6 months ago
JSON representation
VueJs boilerplate using Typescript, Vuex and Vue Router
- Host: GitHub
- URL: https://github.com/twcapps/vue-typescript-boilerplate
- Owner: twcapps
- License: mit
- Created: 2017-04-14T12:59:02.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-13T09:16:07.000Z (over 7 years ago)
- Last Synced: 2025-05-19T19:21:18.956Z (7 months ago)
- Language: JavaScript
- Size: 684 KB
- Stars: 58
- Watchers: 7
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vue - vue-typescript-boilerplate - VueJs boilerplate using Typescript, Vuex and Vue Router (Scaffold [🔝](#readme))
- awesome-vue-zh - Vue排版样板
- awesome-vue - vue-typescript-boilerplate ★48 - A Vue.js typescript SPA starter with Vue 2, Vue Typed, Vuex, Vue Router and localization (Scaffold / Client)
- awesome-vue - vue-typescript-boilerplate - A Vue.js typescript SPA starter with Vue 2, Vue Typed, Vuex, Vue Router and localization (Scaffold / Client)
- awesome-vue - vue-typescript-boilerplate - A Vue.js typescript SPA starter with Vue 2, Vue Typed, Vuex, Vue Router and localization (Components & Libraries / Scaffold)
README
# vue-webpack-boilerplate
> A full-featured Webpack Typescript setup with hot-reload, lint-on-save, unit testing & css extraction.
> Including Vue-component-class, Vuex, Vue-router and localisation
## Documentation
- [For this template](http://vuejs-templates.github.io/webpack): common questions specific to this template are answered and each part is described in greater detail
- [For Vue 2.0](http://vuejs.org/guide/): general information about how to work with Vue, not specific to this template
## Usage
This is a project template for [vue-cli](https://github.com/vuejs/vue-cli). **It is recommended to use npm 3+ for a more efficient dependency tree.**
``` bash
$ npm install -g vue-cli
$ vue init twcapps/vue-typescript-boilerplate my-project
$ cd my-project
$ npm install
$ npm run dev
```
This will scaffold the project using the `master` branch. If you wish to use the latest version of the webpack template, do the following instead:
``` bash
$ vue init webpack#develop my-project
```
:warning: **The develop branch is not considered stable and can contain bugs or not build at all, so use at your own risk.**
The development server will run on port 8080 by default. If that port is already in use on your machine, the next free port will be used.
## 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 TSLint
- Source maps
- `npm run build`: Production ready build.
- JavaScript minified with [UglifyJS v3](https://github.com/mishoo/UglifyJS2/tree/harmony).
- HTML minified with [html-minifier](https://github.com/kangax/html-minifier).
- CSS across all components extracted into a single file and minified with [cssnano](https://github.com/ben-eb/cssnano).
- Static assets compiled with version hashes for efficient long-term caching, and an auto-generated production `index.html` with proper URLs to these generated assets.
- Use `npm run build --report`to build with bundle size analytics.
- `npm run unit`: Unit tests run in [JSDOM](https://github.com/tmpvar/jsdom) with [Jest](https://facebook.github.io/jest/), or in PhantomJS with Karma + Mocha + karma-webpack.
- Supports ES2015+ in test files.
- Easy mocking.
- `npm run e2e`: End-to-end tests with [Nightwatch](http://nightwatchjs.org/).
- 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`:
``` bash
vue init username/repo my-project
```