1 | # 🐸 @omni-door/tpl-component-vue
|
2 | The Vue Component project template
|
3 |
|
4 | [![NPM downloads](http://img.shields.io/npm/dm/%40omni-door%2Ftpl-component-vue.svg?style=flat-square)](https://www.npmjs.com/package/@omni-door/tpl-component-vue)
|
5 | [![npm version](https://badge.fury.io/js/%40omni-door%2Ftpl-component-vue.svg)](https://badge.fury.io/js/%40omni-door%2Ftpl-component-vue)
|
6 | [![install size](https://packagephobia.now.sh/badge?p=%40omni-door%2Ftpl-component-vue)](https://packagephobia.now.sh/result?p=%40omni-door%2Ftpl-component-vue)
|
7 | [![license](http://img.shields.io/npm/l/%40omni-door%2Ftpl-component-vue.svg)](https://github.com/omni-door/tpls/blob/master/packages/tpl-component-vue/LICENSE)
|
8 |
|
9 | ## Install
|
10 | * Clone the repo: `git@github.com:omni-door/tpls.git`
|
11 |
|
12 | * Install with [Npm](https://www.npmjs.com/package/@omni-door/tpl-component-vue): `npm install @omni-door/tpl-component-vue`
|
13 |
|
14 | * Install with [Yarn](https://yarnpkg.com/en/package/@omni-door/tpl-component-vue): `yarn add @omni-door/tpl-component-vue`
|
15 |
|
16 | ## Templates
|
17 | | folder | file |
|
18 | | --- | --- |
|
19 | | babel | babel.config.js |
|
20 | | commitlint | commitlint.config.js |
|
21 | | editor | .editorconfig |
|
22 | | eslint | .eslintrc.js |
|
23 | | ignore | .eslintignore & .gitignore & .npmignore & .prettierignore |
|
24 | | jest | jest.config.js |
|
25 | | new | the standard templates for `omni new` command |
|
26 | | omni | omni.config.js |
|
27 | | package | package.json |
|
28 | | prettier | prettier.config.js |
|
29 | | readme | README.md & README.zh-CN.md & DEV.md & DEV.zh-CN.md |
|
30 | | source | the standard templates in `src` folder |
|
31 | | storybook | .storybook/config.js & .storybook/addons.js & .storybook/manager-head.html & .storybook/webpack.config.js |
|
32 | | stylelint | stylelint.config.js |
|
33 | | tsconfig | tsconfig.json |
|
34 | | vsc | .vscode/settings.json |
|