# vue3工具组件库

**Repository Path**: dbafu/vue-tools

## Basic Information

- **Project Name**: vue3工具组件库
- **Description**: 用于vue 3.x + typescript项目中
此项目实现和展示基于
vue^3.2.20+typescript^4.4.4+vite^2.6.13
集成和实现简单实用的组件、工具、特效
目的是其他项目可以直接复制单个文件或者文件夹即可直接使用
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-06
- **Last Updated**: 2022-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vite 2.x + Vue 3.x + TypeScript Starter

> 快速实现效果和功能模板，用于vue 3.x + typescript项目中 此项目实现和展示基于 vue^3.2.20+typescript^4.4.4+vite^2.6.13 + element plus^1.2.0-beta.5 集成和实现简单实用的组件、工具、特效等

## 在线预览

https://待添加/

## 技术栈

- 编程语言：[TypeScript 4.x](https://www.typescriptlang.org/zh/) + [JavaScript](https://www.javascript.com/)
- 构建工具：[Vite 2.x](https://cn.vitejs.dev/)
- 前端框架：[Vue 3.x](https://v3.cn.vuejs.org/)
- UI 框架：[Element Plus](https://element-plus.org/#/zh-CN)
- 路由工具：[Vue Router 4.x](https://next.router.vuejs.org/zh/index.html)
- CSS 预编译：[Stylus](https://stylus-lang.com/) / [Sass](https://sass.bootcss.com/documentation) / [Less](http://lesscss.cn/)
- HTTP 工具：[Axios](https://axios-http.com/)
- Git Hook 工具：[husky](https://typicode.github.io/husky/#/) + [lint-staged](https://github.com/okonet/lint-staged)
- 代码规范：[EditorConfig](http://editorconfig.org) + [Prettier](https://prettier.io/) + [ESLint](https://eslint.org/) + [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript#translation)
- 提交规范：[Commitizen](http://commitizen.github.io/cz-cli/) + [Commitlint](https://commitlint.js.org/#/)
- 单元测试：[vue-test-utils](https://next.vue-test-utils.vuejs.org/) + [jest](https://jestjs.io/) + [vue-jest](https://github.com/vuejs/vue-jest) + [ts-jest](https://kulshekhar.github.io/ts-jest/)
- 自动部署：[GitHub Actions](https://docs.github.com/cn/actions/learn-github-actions)

## 快速开始

### 获取项目

#### 使用 Git

```sh
git clone https://gitee.com/veigarchen/vue-tools.git
```

#### 使用 NPM

```sh
npm install vite-vue-ts-cli -g

vite-vue-ts-create myapp
```

### 安装依赖

```sh
npm install
# or
yarn add
```

### 启动项目

```sh
npm run dev
```

### 项目打包

```sh
npm run build
```

## Q&A

1. Q: `git cz` 不生效  

   A: 请全局安装 commitizen，命令：`npm install commitizen -g`

2. Q: husky 报错  

   A: 请检查你的项目下是否有 Git 仓库，没有则先 `git init` 初始化一个

## 许可

MIT Copyright © 2021 XPoet