Geeker-Admin:开源后台管理框架
引言
在快速发展的前端开发领域,寻找一个强大、灵活且易于维护的后台管理框架是每个开发者的梦想。Geeker-Admin,一个基于Vue3.4、TypeScript、Vite5等最新技术栈构建的开源项目,正是为了满足这一需求而生。它不仅集成了高效的ProTable组件,还封装了丰富的常用组件、Hooks、指令等,让开发者能够以前所未有的速度构建出功能强大且用户友好的后台管理系统。
介绍 ?
Geeker-Admin 是一款基于 Vue3.4、TypeScript、Vite5、Pinia、Element-Plus 开源的后台管理框架,使用目前最新的技术栈开发。项目提供了强大的 ProTable 组件,在提高开发效率的同时,也封装了一些常用组件、Hooks、指令、动态路由以及按钮级别的权限控制功能。
- 在线预览 ?: Link
- 代码仓库 ⭐:
- Gitee: Geeker-Admin on Gitee
- GitHub: Geeker-Admin on GitHub
- 项目文档 ?: 项目文档
- 更新日志: CHANGELOG.md
项目功能 ?
- 基于 Vue3.4 + TypeScript 开发,采用
<script setup>
单文件组件模式。 - 使用 Vite5 作为项目开发和打包工具(支持 gzip/brotli 压缩、tsx 语法、跨域代理等功能)。
- 采用 Pinia 替代 Vuex,轻量化且易用,并集成了 Pinia 持久化插件。
- 对 Axios 进行了 TypeScript 二次封装,支持请求拦截、请求取消等功能。
- 基于 Element Plus 二次封装了 ProTable 组件,使表格页面配置更加简洁。
- 支持 Element Plus 组件的大小切换、多主题布局、暗黑模式和 i18n 国际化。
- 使用 VueRouter 配置动态路由和权限拦截,支持页面按钮级别的权限控制。
- 通过 KeepAlive 缓存页面,支持多级嵌套路由的缓存。
- 提供了常用的自定义指令(如权限、复制、水印、拖拽、节流、防抖、长按等)。
- 采用 Prettier 统一代码格式,并集成 ESLint 和 Stylelint 进行代码规范校验。
- 使用 husky、lint-staged、commitlint、czg、cz-git 规范提交信息。
安装使用步骤 ?
Clone 仓库:
# Gitee
git clone https://gitee.com/HalseySpicy/Geeker-Admin.git
# GitHub
git clone https://github.com/HalseySpicy/Geeker-Admin.git
安装依赖:
pnpm install
启动项目:
pnpm dev
pnpm serve
项目打包:
# 开发环境
pnpm build:dev
# 测试环境
pnpm build:test
# 生产环境
pnpm build:pro
代码检测与格式化:
# eslint 检测代码
pnpm lint:eslint
# prettier 格式化代码
pnpm lint:prettier
# stylelint 格式化样式
pnpm lint:stylelint
提交代码:
# 提交代码(提交前会自动执行 lint:lint-staged 命令)
pnpm commit
文件资源目录 ?
Geeker-Admin
├─ .husky # husky 配置文件
├─ .vscode # VSCode 推荐配置
├─ build # Vite 配置项
├─ public # 静态资源文件(该文件夹不会被打包)
├─ src
│ ├─ api # API 接口管理
│ ├─ assets # 静态资源文件
│ ├─ components # 全局组件
│ ├─ config # 全局配置项
│ ├─ directives # 全局指令文件
│ ├─ enums # 项目常用枚举
│ ├─ hooks # 常用 Hooks 封装
│ ├─ languages # 语言国际化 i18n
│ ├─ layouts # 框架布局模块
│ ├─ routers # 路由管理
│ ├─ stores # pinia store
│ ├─ styles # 全局样式文件
│ ├─ typings # 全局 ts 声明
│ ├─ utils # 常用工具库
│ ├─ views # 项目所有页面
│ ├─ App.vue # 项目主组件
│ ├─ main.ts # 项目入口文件
│ └─ vite-env.d.ts # 指定 ts 识别 vue
├─ .editorconfig # 统一不同编辑器的编码风格
├─ .env # vite 常用配置
├─ .env.development # 开发环境配置
├─ .env.production # 生产环境配置
├─ .env.test # 测试环境配置
├─ .eslintignore # 忽略 Eslint 校验
├─ .eslintrc.cjs # Eslint 校验配置文件
├─ .gitignore # 忽略 git 提交
├─ .prettierignore # 忽略 Prettier 格式化
├─ .prettierrc.cjs # Prettier 格式化配置
├─ .stylelintignore # 忽略 stylelint 格式化
├─ .stylelintrc.cjs # stylelint 样式格式化配置
├─ CHANGELOG.md # 项目更新日志
├─ commitlint.config.cjs # git 提交规范配置
├─ index.html # 入口 html
├─ LICENSE # 开源协议文件
├─ lint-staged.config.cjs # lint-staged 配置文件
├─ package-lock.json # 依赖包版本锁
├─ package.json # 依赖包管理
├─ postcss.config.cjs # postcss 配置
├─ README.md # README 介绍
├─ tsconfig.json # typescript 全局配置
└─ vite.config.ts # vite 全局配置文件
浏览器支持 ?
本地开发推荐使用 Chrome 最新版浏览器。生产环境支持现代浏览器,不再支持 IE 浏览器,更多浏览器支持情况可以查看 Can I Use Es Module。
IE | Edge | Firefox | Chrome | Safari |
---|---|---|---|---|
不支持 | 最新两个版本 | 最新两个版本 | 最新两个版本 | 最新两个版本 |
项目后台接口 ?
项目后台接口完全采用 Mock 数据,感谢以下 Mock 平台的支持:
总结
Geeker-Admin 框架以其现代化的技术栈和强大的功能集,为开发者提供了一个高效、可扩展的后台管理解决方案。通过精心设计的组件和工具,它极大地简化了开发流程,提高了开发效率。无论是初创企业还是大型项目,Geeker-Admin 都能提供必要的支持,帮助团队快速实现复杂的后台管理功能。随着技术的不断进步,Geeker-Admin 也将持续更新,以保持其在前端开发领域的领先地位。