README.zh-CN.md 5.1 KB

Meet-Admin

English | 中文

介绍

Meet-Admin 一款基于 Vue3.4、TypeScript、Vite5、Pinia、Element-Plus 开源的后台管理框架,使用目前最新技术栈开发。另外本项目还封装了一些常用组件、Hooks、指令、动态路由等功能。

在线预览

代码仓库

项目文档

项目功能

  • 使用 Vue3.4 + TypeScript 开发,单文件组件<script setup>
  • 采用 Vite5 作为项目开发、打包工具(配置 gzip/brotli 打包、tsx 语法、跨域代理…)
  • 使用 Pinia 替代 Vuex,轻量、简单、易用,集成 Pinia 持久化插件
  • 使用 TypeScript 对 Axios 整个二次封装(请求拦截、取消、常用请求封装…)
  • 支持 Element 组件大小切换、暗黑模式、i18n 国际化
  • 使用 VueRouter 配置动态路由、路由懒加载
  • 使用 KeepAlive 对页面进行缓存,支持多级嵌套路由缓存
  • 使用 husky、lint-staged、commitlint、czg、cz-git 规范提交信息

安装使用步骤

  • Clone:
# GitHub
git clone https://github.com/wjp980108/meet-admin.git
  • Install:
pnpm install
  • Run:
# 开发环境
pnpm dev

# 测试环境
pnpm dev:test

# 生产环境
pnpm dev:prod
  • Build:
# 测试环境
pnpm build:test

# 生产环境
pnpm build
  • Lint:
# Eslint 检测代码
pnpm lint

# Eslint 修复代码
pnpm lint:fix
  • commit:
# 提交代码(提交前会自动执行 lint:lint-staged 命令)
pnpm commit

文件资源目录

Meet-Admin
├─ .github                 # GitHub 配置文件
├─ .husky                  # Husky 配置文件
├─ build                   # Vite 配置文件
├─ public                  # 静态资源文件(该文件夹不会被打包)
├─ src
│  ├─ api                  # API 接口管理
│  ├─ assets               # 静态资源文件
│  ├─ components           # 全局组件
│  ├─ config               # 全局配置项
│  ├─ constants            # 全局常量
│  ├─ directives           # 全局指令文件
│  ├─ hooks                # 常用 Hooks 封装
│  ├─ locales              # 语言国际化 i18n
│  ├─ layouts              # 框架布局模块
│  ├─ router               # 路由管理
│  ├─ stores               # Pinia store
│  ├─ styles               # 全局样式文件
│  ├─ typings              # 全局 ts 声明
│  ├─ utils                # 常用工具库
│  ├─ views                # 项目所有页面
│  ├─ App.vue              # 项目主组件
│  └─ main.ts              # 项目入口文件
├─ .env                    # Vite 常用配置
├─ .env.dev                # 开发环境配置
├─ .env.prod               # 生产环境配置
├─ .env.test               # 测试环境配置
├─ .gitignore              # 忽略 Git 提交
├─ .nvmdrc                 # Node 版本管理配置
├─ CHANGELOG.en-US.md      # 项目更新日志(英文)
├─ CHANGELOG.zh-CN.md      # 项目更新日志(中文)
├─ commitlint.config.js    # Git 提交规范配置
├─ eslint.config.js        # Eslint 配置文件
├─ index.html              # 入口 html
├─ LICENSE                 # 开源协议文件
├─ package.json            # 依赖包管理
├─ pnpm-lock.yaml          # Pnpm 依赖管理
├─ README.md               # README 介绍
├─ README.zh-CN.md         # README 介绍(中文)
├─ tsconfig.json           # Typescript 全局配置
├─ uno.config.ts           # UnoCss 配置文件
└─ vite.config.ts          # Vite 全局配置文件

浏览器支持

  • 本地开发推荐使用 Chrome 最新版浏览器 Download
  • 生产环境支持现代浏览器,不再支持 IE 浏览器,更多浏览器可以查看 Can I Use Es Module
IE Edge Firefox Chrome Safari
not support last 2 versions last 2 versions last 2 versions last 2 versions

项目后台接口

项目后台接口完全采用 Mock 数据,感谢以下 Mock 平台支持: