@omni-door/tpl-spa-vue/README.md

The spa-vue project template

# 🐸 @omni-door/tpl-spa-vue
The spa-vue project template

[![NPM downloads](http://img.shields.io/npm/dm/%40omni-door%2Ftpl-spa-vue.svg?style=flat-square)](https://www.npmjs.com/package/@omni-door/tpl-spa-vue)
[![npm version](https://badge.fury.io/js/%40omni-door%2Ftpl-spa-vue.svg)](https://badge.fury.io/js/%40omni-door%2Ftpl-spa-vue)
[![install size](https://packagephobia.now.sh/badge?p=%40omni-door%2Ftpl-spa-vue)](https://packagephobia.now.sh/result?p=%40omni-door%2Ftpl-spa-vue)
[![license](http://img.shields.io/npm/l/%40omni-door%2Ftpl-spa-vue.svg)](https://github.com/omni-door/tpls/blob/master/packages/tpl-spa-vue/LICENSE)

## Install
* Clone the repo: `git@github.com:omni-door/tpls.git`

* Install with [Npm](https://www.npmjs.com/package/@omni-door/tpl-spa-vue): `npm install @omni-door/tpl-spa-vue`

* Install with [Yarn](https://yarnpkg.com/en/package/@omni-door/tpl-spa-vue): `yarn add @omni-door/tpl-spa-vue`

## Templates
| folder | file |
| --- | --- |
| babel | configs/babel.config.js |
| commitlint | configs/commitlint.config.js |
| editor | .editorconfig |
| eslint | configs/.eslintrc.js |
| ignore | .eslintignore & .gitignore & .npmignore & .prettierignore |
| jest | configs/jest.config.js |
| new | the standard templates for `omni new` command |
| omni | configs/omni.config.js |
| package | package.json |
| prettier | configs/prettier.config.js |
| readme | README.md & README.zh-CN.md |
| source | the standard templates in `src` folder |
| stylelint | configs/stylelint.config.js |
| tsconfig | tsconfig.json |
| vsc | .vscode/settings.json |
| webpack | contain `wepack.config.common.js`, `wepack.config.dev.js`, `wepack.config.prod.js` files |