This commit is contained in:
huzhushan 2021-04-19 16:12:31 +08:00
parent 47eb623cad
commit bfceb0eae6
9 changed files with 1918 additions and 138 deletions

18
.eslintignore Normal file
View File

@ -0,0 +1,18 @@
build/*.js
src/assets
mock
*.sh
node_modules
*.md
*.woff
*.ttf
.vscode
.idea
dist
/public
/docs
.husky
.local
/bin
Dockerfile

22
.eslintrc.js Normal file
View File

@ -0,0 +1,22 @@
module.exports = {
root: true,
env: {
node: true,
},
// extends: ["plugin:vue/vue3-essential", "eslint:recommended", "@vue/prettier"],
parserOptions: {
"parser": "babel-eslint"
},
rules: {
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
"prettier/prettier": [
"warn",
{
// singleQuote: none,
// semi: false,
trailingComma: "es5",
},
],
},
};

25
.gitignore vendored
View File

@ -1,5 +1,28 @@
.DS_Store
node_modules
.DS_Store
dist
dist-ssr
*.local
# local env files
.env.local
.env.*.local
# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
package-lock.json
yarn.lock

View File

@ -5,7 +5,6 @@
<h1>Vue3 Element Admin</h1>
</div>
## 简介
**Vue3 Element Admin** 是一个免费开源的中后台模版。基于`vue3`+`ElementPlus`+`Vite`开发,是一个开箱即用的中后台系统前端解决方案,它可以帮助你快速搭建企业级中后台产品原型,也可用于学习参考。
@ -98,9 +97,9 @@ npm run build
本地开发推荐使用`Chrome 80+` 浏览器
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
| <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" /></br>IE | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" /></br>Edge | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" /></br>Firefox | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" /></br>Chrome | <img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" /></br>Safari |
| :----------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
## 维护者

View File

@ -1,122 +0,0 @@
<div align="center"> <a href="https://github.com/huzhushan/vue3-element-admin"> <img alt="VEA Logo" width="160" src="https://huzhushan.gitee.io/vue3-element-admin-site/assets/logo.1d6978fb.svg"> </a> <br> <br>
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)
<h1>Vue3 Element Admin</h1>
</div>
## 简介
**Vue3 Element Admin** 是一个免费开源的中后台模版。基于`vue3`+`ElementPlus`+`Vite`开发,是一个开箱即用的中后台系统前端解决方案,它可以帮助你快速搭建企业级中后台产品原型,也可用于学习参考。
- [在线预览](https://huzhushan.gitee.io/vue3-element-admin-site/)
- [使用文档](https://huzhushan.gitee.io/vue3-element-admin)
## 项目地址
- [github 项目地址](https://github.com/huzhushan/vue3-element-admin)
- [gitee 项目地址](https://gitee.com/huzhushan/vue3-element-admin)
## 视频教程
- [使用 vue3-element-admin 开发后台管理系统]() - 待更新
- [vue3-element-admin 架构搭建过程]() - 待更新
## 技术储备
> 提前了解和学习以下知识会对您使用本项目有很大的帮助
- [node](http://nodejs.org/) 和 [git](https://git-scm.com/) -项目开发环境
- [Es6+](http://es6.ruanyifeng.com/) - 熟悉 es6 基本语法
- [Vite](https://www.pipipi.net/vite/) - 熟悉 vite 特性
- [Vue3](https://v3.vuejs.org/) - 熟悉 Vue 基础语法
- [Vue-Router-Next](https://next.router.vuejs.org/zh/) - 熟悉 vue-router@4 基本使用
- [Element-Plus](https://element-plus.gitee.io/#/zh-CN) - ui 基本使用
- [Mock.js](https://github.com/nuysoft/Mock) - mockjs 基本语法
## 安装使用
```bash
# 克隆项目
git clone https://github.com/huzhushan/vue3-element-admin.git
# 进入项目目录
cd vue3-element-admin
# 安装依赖
npm install
# 建议不要直接使用 cnpm 安装依赖,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
npm install --registry=https://registry.npm.taobao.org
# 启动服务
npm start
```
## 打包发布
```bash
npm run build
```
## 更新日志
[CHANGELOG](https://github.com/huzhushan/vue3-element-admin/releases)
## 如何贡献
非常欢迎你的加入![提一个 Issue](https://github.com/huzhushan/vue3-element-admin/issues/new/choose) 或者提交一个 Pull Request。
**Pull Request:**
1. Fork 代码!
2. 创建自己的分支: `git checkout -b feat/xxxx`
3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'`
4. 推送您的分支: `git push origin feat/xxxx`
5. 提交`pull request`
## 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` 开发中
## 浏览器支持
本地开发推荐使用`Chrome 80+` 浏览器
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>IE | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt=" Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)</br>Safari |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
## 维护者
[@huzhushan](https://github.com/huzhushan)
## 捐赠
如果你觉得这个项目对你有帮助,你可以帮作者买一杯果汁表示支持:tropical_drink:
![donate](https://huzhushan.gitee.io/vue3-element-admin/donate.png)
## 交流
`Vue3-Element-Admin` 是完全开源免费的项目,在帮助开发者更方便地进行中大型管理系统开发,同时也提供 QQ 交流群使用问题欢迎在群内提问。
- QQ 群 `734037120`
## License
[MIT © ZSEN-2020](./LICENSE)

1821
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -12,7 +12,8 @@
"dev:mock": "vite --mode mock",
"build": "vite build",
"build:mock": "vite build --mode mock",
"serve": "vite preview"
"serve": "vite preview",
"lint": "eslint --ext .js,.vue src"
},
"browserslist": [
"> 1%",
@ -27,14 +28,32 @@
"devDependencies": {
"@vitejs/plugin-vue": "^1.1.5",
"@vue/compiler-sfc": "^3.0.5",
"@vue/eslint-config-prettier": "^6.0.0",
"autoprefixer": "^10.2.5",
"babel-eslint": "^10.1.0",
"element-plus": "^1.0.2-beta.35",
"eslint": "^6.7.2",
"eslint-plugin-prettier": "^3.1.3",
"eslint-plugin-vue": "^7.0.0-0",
"husky": "^6.0.0",
"lint-staged": "^10.5.4",
"mockjs": "^1.1.0",
"prettier": "^1.19.1",
"sass": "^1.32.8",
"vite": "^2.1.0",
"vite-plugin-mock": "^2.3.0",
"vite-plugin-svg-icons": "^0.4.0",
"vue3-pro-table": "^1.0.0"
"vite-plugin-svg-icons": "^0.4.0"
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"src/**/*.{js,vue}": [
"eslint --fix",
"git add"
]
},
"repository": {
"type": "git",

11
prettier.config.js Normal file
View File

@ -0,0 +1,11 @@
module.exports = {
printWidth: 80, // 每行代码长度默认80
tabWidth: 2, // 每个tab相当于多少个空格默认2
useTabs: false, // 是否使用tab进行缩进默认false
singleQuote: false, // 使用单引号默认false
semi: true, // 声明结尾使用分号(默认true)
trailingComma: 'es5', // 多行使用拖尾逗号默认none
bracketSpacing: true, // 对象字面量的大括号间使用空格默认true
jsxBracketSameLine: false, // 多行JSX中的>放置在最后一行的结尾而不是另起一行默认false
arrowParens: "avoid", // 只有一个参数的箭头函数的参数是否带圆括号默认avoid
};

View File

@ -34,7 +34,7 @@ export default env => {
preprocessorOptions: {
scss: {
// 全局变量
additionalData: '@import "./src/assets/style/global-variables.scss";'
additionalData: '@import "./src/assets/style/global-variables.scss";'
}
}
},
@ -67,7 +67,8 @@ export default env => {
output: {
// 拆分单独模块
manualChunks: {
'element-plus': ['element-plus']
'element-plus': ['element-plus'],
'mockjs': ['mockjs']
}
}
},