# vite-vue3-ts-template

**Repository Path**: gandalao/vite-vue3-ts-template

## Basic Information

- **Project Name**: vite-vue3-ts-template
- **Description**: vite-vue3-ts-admin
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-29
- **Last Updated**: 2023-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue, TypeScript

## README

### 🚀 开发技术

- vite: [https://vitejs.cn](https://vitejs.cn/) 下一代前端开发与构建工具

- vue3:[https://cn.vuejs.org/](https://cn.vuejs.org/) 渐进式 JavaScript 框架

- typescript:[https://www.tslang.cn/](https://www.tslang.cn/) javascript超集

- element-plus:[https://element-plus.org/](https://element-plus.org/) 基于 Vue 3，面向设计师和开发者的组件库

- pinia:[https://pinia.web3doc.top/](https://pinia.web3doc.top/) 新一代Vue 存储库

### 🐳 安装使用

- 安装依赖

```
pnpm install
```

- 启动项目

```
pnpm run dev
```

- 打包

```
pnpm run build
```

### 🎨 目录结构

```
├── dist                       # 打包文件
├── node_modules               # 依赖包
├── public                     # 资源文件，不会参与编译
├── src                        # 源代码
│   ├── api                    # 所有请求
│   ├── assets                 # 主题 变量等资源
│   ├── components             # 全局公用组件
│   ├── icons                  # 项目所有 svg icons
│   ├── layout                 # 全局 layout
│   ├── router                 # 路由
│   ├── store                  # 全局 store管理
│   ├── styles                 # 全局样式
│   ├── utils                  # 全局公用方法
│   ├── views                  # 所有页面
│   ├── App.vue                # 入口页面
│   ├── main.ts                # 入口文件
├── .eslintignore              # ESLint 校验忽略文件
├── .eslintrc.cjs              # ESLint 配置文件
├── .gitignore                 # git提交忽略文件
├── index.html                 # html模板
├── package.json               # package.json
├── tsconfig.json              # ts 配置文件
├── tsconfig.node.json         # ts-node 配置文件
├── vite.config.ts             # vite 配置文件
```

### 🌱 git提交规范说明

```
'feat', // 新特性、新功能
'fix', //修改bug
'docs', //文档修改
'style', //代码格式修改，注意不是 css 修改
'refactor',//代码重构
'perf', //优化相关，如提升性能、体验
'test', //测试用例修改
'chore',//其他修改，如改变构建流程、或者增加依赖库、工具等
'revert',//回滚到上一个版本
'build',//编译相关的修改，例如发布版本、对项目构建或者依赖的改的
```