# vite-vue-admin

**Repository Path**: loyin/vite-admin

## Basic Information

- **Project Name**: vite-vue-admin
- **Description**: vue3.0+vuex@4+vue-router@4+vite+typescript+mock
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://peng-xiao-shuai-0902.github.io/vite-vue-admin/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2021-07-01
- **Last Updated**: 2023-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Vite-Vue-Admin
<div align="center">
	<img style="width:100px;" object-fit='cover' src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBH
ZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIyLjAuMSwgU1ZHIEV4cG9y
dCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8
c3ZnIHZlcnNpb249IjEuMSIgaWQ9IuWbvuWxgl8xIiB4bWxucz0iaHR0cDov
L3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3
LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCIKCSB2aWV3Qm94
PSIwIDAgNDEwIDQwNCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAw
IDAgNDEwIDQwNDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8c3R5bGUgdHlw
ZT0idGV4dC9jc3MiPgoJLnN0MHtmaWxsOnVybCgjTGF5ZXJfMV8pO30KCS5z
dDF7ZmlsbDp1cmwoI0xheWVyX2NvcHlfMV8pO30KPC9zdHlsZT4KPHRpdGxl
PmxvZ28tc3ZnPC90aXRsZT4KPGxpbmVhckdyYWRpZW50IGlkPSJMYXllcl8x
XyIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiIHgxPSIxMDcuMDQ2
MyIgeTE9IjQ0Ny40MDM4IiB4Mj0iMzM2LjA0NjMiIHkyPSIxMzYuNDAzOCIg
Z3JhZGllbnRUcmFuc2Zvcm09Im1hdHJpeCgxIDAgMCAtMSAwIDQwNikiPgoJ
PHN0b3AgIG9mZnNldD0iMCIgc3R5bGU9InN0b3AtY29sb3I6IzQxRDFGRiIv
PgoJPHN0b3AgIG9mZnNldD0iMSIgc3R5bGU9InN0b3AtY29sb3I6I0JEMzRG
RSIvPgo8L2xpbmVhckdyYWRpZW50Pgo8cGF0aCBpZD0iTGF5ZXIiIGNsYXNz
PSJzdDAiIGQ9Ik0zOTkuNiw1OS41bC0xODQsMzI5Yy0zLjgsNi44LTEzLjYs
Ni44LTE3LjQsMC4xTDEwLjYsNTkuNkM2LjQsNTIuMiwxMi43LDQzLjMsMjEs
NDQuOGwxNDUuNiwyNS40CgljMCwwLDcuNCwyLjIsOS43LDkuN0MxNzguNiw4
Ny4zLDIwMywxNzQsMjAzLDE3NGMxLjIsMC4yLDIuNCwwLjIsMy42LDBjMCww
LDI2LjMtODgsMjguMy05NC4xUzI0Myw3MiwyNDMsNzJsMTQ2LjEtMjcuMgoJ
QzM5Ny40LDQzLjMsNDAzLjgsNTIuMSwzOTkuNiw1OS41eiIvPgo8bGluZWFy
R3JhZGllbnQgaWQ9IkxheWVyX2NvcHlfMV8iIGdyYWRpZW50VW5pdHM9InVz
ZXJTcGFjZU9uVXNlIiB4MT0iMjAzLjkzNzQiIHkxPSIzNTcuMDgwNyIgeDI9
IjIzNi44NDk0IiB5Mj0iMTMxLjMwOTciIGdyYWRpZW50VHJhbnNmb3JtPSJt
YXRyaXgoMSAwIDAgLTEgMCA0MDYpIj4KCTxzdG9wICBvZmZzZXQ9IjAiIHN0
eWxlPSJzdG9wLWNvbG9yOiNGRkVBODMiLz4KCTxzdG9wICBvZmZzZXQ9Ijgu
Mjk5OTk5ZS0wMiIgc3R5bGU9InN0b3AtY29sb3I6I0ZGREQzNSIvPgoJPHN0
b3AgIG9mZnNldD0iMSIgc3R5bGU9InN0b3AtY29sb3I6I0ZGQTgwMCIvPgo8
L2xpbmVhckdyYWRpZW50Pgo8cGF0aCBpZD0iTGF5ZXJfY29weSIgY2xhc3M9
InN0MSIgZD0iTTMxMi44LDUwLjNjMCwwLTczLjUsMTMuNC03NiwxNGMtMi40
LDAuNi0yLjgsMS42LTUuOSwxMS4yYy0yLjQsNy42LTI0LjUsOTAtMjUuOSw5
MAoJcy0yMS43LTc4LjctMjUuOC04OS44Yy00LjEtMTEtMy42LTEyLjEtNi40
LTEzYy0yLjgtMC44LTY5LjctMTMuMi03Ni4yLTEzLjlzLTcuOCwzLjctNy4z
LDcuOGMwLDAsNC4xLDAuNyw0LjIsMC44bDExMS4yLDI0OC4xCgljMi45LDQu
Nyw0LjEsNC40LDYuOCwwLjFsMTA1LTI0Ny40bDQuMi0wLjdDMzIxLjYsNTQu
MiwzMTYuMiw0OS43LDMxMi44LDUwLjN6Ii8+Cjwvc3ZnPgo=">
	<p>&nbsp;</p>
	<p align="center">
      <a href="https://vitejs.dev/" target="_blank">
		    <img src="https://img.shields.io/badge/vite-%3E2.3.0-yellow" alt="vite">
		</a>
	    <a href="https://v3.vuejs.org/" target="_blank">
	        <img src="https://img.shields.io/badge/vue.js-vue3.1.x-green" alt="vue">
	    </a>
	    <a href="https://element-plus.gitee.io/#/zh-CN/component/changelog" target="_blank">
	        <img src="https://img.shields.io/badge/element--plus-%3E1.0.0-blue" alt="element plus">
	    </a>
		<a href="https://www.tslang.cn/" target="_blank">
         <img src="https://img.shields.io/badge/typescript-%3E4.0.0-blue" alt="typescript">
	    </a>
		<a href="https://gitee.com/abc1612565136/vite-admin/blob/master/LICENSE" target="_blank">
		    <img src="https://img.shields.io/badge/LICENSE-MIT-success" alt="license">
		</a>
	</p>
	<p>&nbsp;</p>
</div>

[English](./README.md) | **简体中文**

## 介绍

**Cli 配置**

- vue3.X
- vuex@4
- vue-router@4
- vite@2
- typescript
- mock

**内置 element-plus 二开封装**

- `upload-file` (文件上传，支持指定文件格式，文件大小)
- `powerful-table` (多功能表格组件)[文档说明](https://gitee.com/abc1612565136/powerful-table/blob/master/README.md)

## 项目设置

> **注意事项**

1. 默认是开发版本和发行版本都是使用 `mock`
   发行版本如需禁用 `mock` 请将 `main.ts` 文件下的如下代码取消注释
   并且找到 `.env.production` 文件下的 `VITE_MOCK` 变量修改其 `false`
2. 开发版本禁用 `mock` 请将`.env.development` 文件下的 `VITE_MOCK` 变量修改其 `false`

```js
// main.ts

// if (
//   import.meta.env.VITE_MOCK === "true"
// ) {
mockXHR()
// }
```

### 一、安装依赖项

```bash
$ yarn
```

or

```
$ npm install
```

> 推荐使用 yarn , **[yarn 安装与常用命令](http://liqingsong.cc/article/detail/9)** 。

### 二、编译为开发环境

```bash
$ yarn dev
```

or

```
$ npm run dev
```

### 三、编译为生产环境

```bash
$ yarn build
```

or

```
$ npm run build
```

### 四、本地预览生产构建产物

```bash
$ yarn preview
```

or

```
$ npm run preview
```

## 捐赠

如果你觉得这个项目帮助到了你，请帮助点击 Star

## Git 贡献提交规范

- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))

  - `feat` 添加新功能
  - `fix` 修复问题/BUG
  - `style` 代码风格相关，不影响运行结果
  - `perf` 优化/性能提升
  - `refactor` 重构
  - `revert` 撤消 编辑
  - `test` 测试相关
  - `docs` 文档/注释
  - `chore` 依赖更新/脚手架配置修改等。
  - `workflow` 工作流程改进
  - `ci` 持续集成
  - `types` 类型定义文件更改
  - `wip` 开发中

## 计划 （2021-3-30）

- [x] 组件菜单 > 文件上传
- [x] 组件菜单 > 腾讯地图
- [x] 组件菜单 > 图形编辑
- [x] 组件菜单 > 签名
- [x] 国际化多语言
- [x] 图表菜单
- [x] 图标菜单
- [x] 全局 `el-button(el-**)` 大小
- [x] 全局主题颜色修改
- [x] 新增日志菜单 捕获接口报错 以及 errorHandler
- [x] 公共配置
- [x] 使用 JSX/TSX /src/layout/components/nav-right
- [x] markdown 编辑器（支持公式、表情、流程图...）
- [x] 权限测试菜单（权限指令）
- [ ] 登录密码使用MD5加密存本地
- [ ] excel 导入导出
- [ ] 打印指令、复制指令
- [x] 全局指令
- [x] 全局水印

**其他功能可以在 `issues` 提出**