Technical Documentation: pure-admin/vue-pure-admin
ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference
Overview (`README.md`)
vue-pure-admin
中文 | English
简介
vue-pure-admin 是一款开源免费且开箱即用的中后台管理系统模版。完全采用 ECMAScript 模块（ESM）规范来编写和组织代码，使用了最新的 Vue3、Vite、Element-Plus、TypeScript、Pinia、Tailwindcss 等主流技术开发
研发理念
稳定中求创新，技术中见未来
精简版本（实际项目开发请用精简版本，提供 `非国际化` 、`国际化` 两个版本选择）
精简版本是基于 vue-pure-admin 提炼出的架子，包含主体功能，更适合实际项目开发，打包后的大小在全局引入 element-plus 的情况下仍然低于 2.3MB，并且会永久同步完整版的代码。开启 brotli 压缩和 cdn 替换本地库模式后，打包大小低于 350kb
配套视频
配套保姆级文档
点我查看 vue-pure-admin 文档
点我查看 @pureadmin/utils 文档
高级服务
`Tauri` 版本
`Electron` 版本
预览
PC 端
暗色风格
移动端
使用 `Gitpod`
在 Gitpod（适用于 GitHub 的免费在线开发环境）中打开项目，并立即开始编码.
安装使用
拉取代码
推荐使用 `@pureadmin/cli` 脚手架
- 全局安装
npm install @pureadmin/cli- 交互式选择模板并创建项目
pure create从 `GitHub` 上拉取
git clone https://github.com/pure-admin/vue-pure-admin.git从 `Gitee` 上拉取
git clone https://gitee.com/yiming_chang/vue-pure-admin.git安装依赖
cd vue-pure-admin
pnpm install启动平台
pnpm dev项目打包
pnpm buildDocker 支持
- 自定义镜像名为
vue-pure-admin的镜像（请注意下面命令末尾有一个点.表示使用当前路径下的Dockerfile文件，可根据实际情况指定路径）
docker build -t vue-pure-admin .- 端口映射并启动
docker容器（8080:80：表示在容器中使用80端口，并将该端口转发到主机的8080端口；pure-admin：表示自定义容器名；vue-pure-admin：表示自定义镜像名）
docker run -dp 8080:80 --name pure-admin vue-pure-admin操作完上面两个命令后，在浏览器打开 http://localhost:8080 即可预览
当然也可以通过 Docker Desktop 可视化界面去操作 docker 项目，如下图
更新日志
如何贡献
非常欢迎您的加入！提一个 Issue 或者提交一个 Pull Request
Pull Request:
- Fork 代码!
- 创建自己的分支:
git checkout -b feat/xxxx - 提交您的修改:
git commit -am 'feat(function): add xxxxx' - 推送您的分支:
git push origin feat/xxxx - 提交
pull request
特别代码贡献
非常感谢你们能深入了解源码并对 pure-admin 组织作出优秀贡献 ❤️
| 贡献人 | 具体代码 |
|---|---|
| hb0730 | 代码 |
| o-cc | 代码 |
| yj-liuzepeng | 代码 |
| skyline523 | 代码 |
| shark-lajiao | 代码 |
| WitMiao | 代码 |
| QFifteen | 代码 |
| edgexie | 代码 |
| way-jm | 代码 |
| simple-hui | 代码 |
| tinysimple | 代码 |
`Git` 贡献提交规范
feat增加新功能fix修复问题/BUGstyle代码风格相关无影响运行结果的perf优化/性能提升refactor重构revert撤销修改test测试相关docs文档/注释chore依赖更新/脚手架配置修改等workflow工作流改进ci持续集成types类型定义文件更改wip开发中
浏览器支持
本地开发推荐使用 Chrome、Edge、Firefox 浏览器，作者常用的是最新版 Chrome 浏览器
实际使用中感觉 Firefox 在动画上要比别的浏览器更加丝滑，只是作者用 Chrome 已经习惯了，看个人爱好选择吧
更详细的浏览器兼容性支持请看 Vue 支持哪些浏览器？ 和 Vite 浏览器兼容性
| IE | Edge | Firefox | Chrome | Safari |
|---|---|---|---|---|
| 不支持 | 最后两个版本 | 最后两个版本 | 最后两个版本 | 最后两个版本 |
维护者
许可证
完全免费开源
MIT © 2020-present, pure-admin
`Star`
非常感谢留下星星的好心人，感谢您的支持 :heart:
`Fork`
瞧，那些 小哥哥 、小姐姐 认真 学习 的样子真滴是 哎呦不错哦 :heart:
Overview (`src/utils/README.md`)
注意
vue-pure-admin从3.3.0版本之后（不包括3.3.0版本），大部分工具和hooks都集成到了 @pureadmin/utils- npm
- 文档代码地址
Overview (`src/views/system/menu/README.md`)
字段含义
| 字段 | 说明 |
|---|---|
menuType |
菜单类型（0代表菜单、1代表iframe、2代表外链、3代表按钮） |
parentId |
|
title |
菜单名称（兼容国际化、非国际化，如果用国际化的写法就必须在根目录的locales文件夹下对应添加） |
name |
路由名称（必须唯一并且和当前路由component字段对应的页面里用defineOptions包起来的name保持一致） |
path |
路由路径 |
component |
组件路径（传component组件路径，那么path可以随便写，如果不传，component组件路径会跟path保持一致） |
rank |
菜单排序（平台规定只有home路由的rank才能为0，所以后端在返回rank的时候需要从非0开始 点击查看更多） |
redirect |
路由重定向 |
icon |
菜单图标 |
extraIcon |
右侧图标 |
enterTransition |
进场动画（页面加载动画） |
leaveTransition |
离场动画（页面加载动画） |
activePath |
菜单激活（将某个菜单激活，主要用于通过query或params传参的路由，当它们通过配置showLink: false后不在菜单中显示，就不会有任何菜单高亮，而通过设置activePath指定激活菜单即可获得高亮，activePath为指定激活菜单的path） |
auths |
权限标识（按钮级别权限设置） |
frameSrc |
链接地址（需要内嵌的iframe链接地址） |
frameLoading |
加载动画（内嵌的iframe页面是否开启首次加载动画） |
keepAlive |
缓存页面（是否缓存该路由页面，开启后会保存该页面的整体状态，刷新后会清空状态） |
hiddenTag |
标签页（当前菜单名称或自定义信息禁止添加到标签页） |
fixedTag |
固定标签页（当前菜单名称是否固定显示在标签页且不可关闭） |
showLink |
菜单（是否显示该菜单） |
showParent |
父级菜单（是否显示父级菜单 点击查看更多） |
--- METRICS ---
- Files Extracted: 3
- Estimated Token Budget: ~3056 tokens
- Canonical Reference: https://codewiki.google/github.com/pure-admin/vue-pure-admin