# vue3-element-admin

**Repository Path**: yuqi_work/vue3-element-admin

## Basic Information

- **Project Name**: vue3-element-admin
- **Description**: 🔥Vue3 + Vite6 + TypeScript + Element-Plus 构建的后台管理前端模板，配套官方 Java 和 Node 后端源码，vue-element-admin 的 Vue3 版本。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://vue.youlai.tech
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2138
- **Created**: 2025-04-27
- **Last Updated**: 2025-04-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img alt="umall-admin" width="80" height="80" src="./src/assets/logo.png">
  <h1>umall-admin</h1>

  <img src="https://img.shields.io/badge/Vue-3.5.13-brightgreen.svg"/>
  <img src="https://img.shields.io/badge/Vite-6.2.2-green.svg"/>
  <img src="https://img.shields.io/badge/Element Plus-2.9.7-blue.svg"/>
  <img src="https://img.shields.io/badge/license-MIT-green.svg"/>
</div>

## 项目简介

umall-admin 是基于 Vue3、Vite、TypeScript 和 Element-Plus 搭建的企业级后台管理前端模板，开箱即用。

## 项目特色

- **简洁易用**：基于 Vue3 生态系统构建，无过渡封装，易上手。
- **数据交互**：支持 `Mock` 数据和线上接口文档。
- **系统功能**：提供用户管理、角色管理、菜单管理、部门管理、字典管理等功能模块。
- **权限管理**：支持动态路由、按钮权限、角色权限和数据权限等多种权限管理方式。
- **基础设施**：提供国际化、多布局、暗黑模式、全屏、水印、接口文档和代码生成器等功能。

## 项目截图

![](https://www.youlai.tech/storage/blog/2025/01/18/20250118160647.png)

![](https://www.youlai.tech/storage/blog/2025/01/18/20250118183539.png)

## 项目启动

- **环境准备**

| 环境类型       | 名称                     |
|----------------|--------------------------|
| **开发工具**   | [Visual Studio Code](https://code.visualstudio.com/Download)/[WebStorm](https://www.jetbrains.com.cn/webstorm/) |
| **运行环境**   | Node 18 + (推荐[22.9.0](https://npmmirror.com/mirrors/node/v22.9.0/))  |
> ⚠️ 注意：Node.js 20.6.0版本存在兼容性问题，请勿使用

- **快速开始**

```bash
# 克隆代码
git clone [项目仓库地址]

# 切换目录
cd umall-admin

# 安装 pnpm
npm install pnpm -g

# 设置镜像源(可忽略)
pnpm config set registry https://registry.npmmirror.com

# 安装依赖
pnpm install

# 启动运行
pnpm run dev
```

## 项目部署

执行 `pnpm run build` 命令后，项目将被打包并生成 `dist` 目录。接下来，将 `dist` 目录下的文件上传到服务器 `/usr/share/nginx/html` 目录下，并配置 Nginx 进行反向代理。

```bash
pnpm run build
```

以下是 Nginx 的配置示例：

```nginx
server {
    listen      80;
    server_name localhost;

    location / {
        root   /usr/share/nginx/html;
        index  index.html index.htm;
    }

    # 反向代理配置
    location /prod-api/ {
        # 请将此处替换为您的后端 API 地址，并注意保留后面的斜杠 /
        proxy_pass http://your-api-address/;
    }
}
```

## 本地Mock

项目同时支持在线和本地 Mock 接口，默认使用线上接口，如需替换为 Mock 接口，修改文件 `.env.development` 的 `VITE_MOCK_DEV_SERVER` 为  `true` **即可**。

## 提交规范

执行 `pnpm run commit` 唤起 git commit 交互，根据提示完成信息的输入和选择。