README.md
    中文 | English

    项目简介

    vue3-element-admin 是基于 Vue3 + Vite5+ TypeScript5 + Element-Plus + Pinia 等主流技术栈构建的免费开源的后台管理前端模板(配套后端源码)。

    项目特色

    • 简洁易用:基于 vue-element-admin 升级的 Vue3 版本,无过渡封装 ,易上手。

    • 数据交互:同时支持本地 Mock 和线上接口,配套 Java 后端源码在线接口文档

    • 权限管理:用户、角色、菜单、字典、部门等完善的权限系统功能。

    • 基础设施:动态路由、按钮权限、国际化、代码规范、Git 提交规范、常用组件封装。

    • 持续更新:2021年至今持续更新3年,及时跟进最新的技术和工具。

    项目预览

    明亮模式

    暗黑模式

    接口文档

    项目地址

    项目 Gitee Github GitCode
    前端 vue3-element-admin vue3-element-admin vue3-element-admin
    后端 youlai-boot youlai-boot youlai-boot

    环境准备

    环境 名称版本 下载地址
    开发工具 VSCode 下载
    运行环境 Node ≥18 下载

    项目启动

    # 克隆代码
    git clone https://gitee.com/youlaiorg/vue3-element-admin.git
    
    # 切换目录
    cd vue3-element-admin
    
    # 安装 pnpm
    npm install pnpm -g
    
    # 安装依赖
    pnpm install
    
    # 启动运行
    pnpm run dev

    项目部署

    # 项目打包
    pnpm run build:prod
    
    # 上传文件至远程服务器
    将打包生成在 `dist` 目录下的文件拷贝至 `/usr/share/nginx/html` 目录
    
    # nginx.cofig 配置
    server {
    	listen     80;
    	server_name  localhost;
    	location / {
    			root /usr/share/nginx/html;
    			index index.html index.htm;
    	}
    	# 反向代理配置
    	location /prod-api/ {
    			proxy_pass http://vapi.youlai.tech/; # vapi.youlai.tech替换成你的后端API地址
    	}
    }

    本地Mock

    项目同时支持在线和本地 Mock 接口,默认使用线上接口,如需替换为 Mock 接口,修改文件 .env.developmentVITE_MOCK_DEV_SERVERtrue 即可

    后端接口

    如果您具备Java开发基础,按照以下步骤将在线接口转为本地后端接口,创建企业级前后端分离开发环境,助您走向全栈之路。

    1. 获取基于 JavaSpringBoot 开发的后端 youlai-boot 源码。
    2. 根据后端工程的说明文档 README.md 完成本地启动。
    3. 修改 .env.development 文件中的 VITE_APP_API_URL 的值,将其从 http://vapi.youlai.tech 更改为 http://localhost:8989。

    注意事项

    • 自动导入插件自动生成默认关闭

      模板项目的组件类型声明已自动生成。如果添加和使用新的组件,请按照图示方法开启自动生成。在自动生成完成后,记得将其设置为 false,避免重复执行引发冲突。

    • 项目启动浏览器访问空白

      请升级浏览器尝试,低版本浏览器内核可能不支持某些新的 JavaScript 语法,比如可选链操作符 ?.

    • 项目同步仓库更新升级

      项目同步仓库更新升级之后,建议 pnpm install 安装更新依赖之后启动 。

    • 项目组件、函数和引用爆红

      重启 VSCode 尝试

    • 其他问题

      如果有其他问题或者建议,建议 ISSUE

    项目文档

    提交规范

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

    交流群🚀

    关注「有来技术」公众号,获取交流群二维码。

    如果交流群的二维码过期,请加微信(haoxianrui)并备注「前端」、「后端」或「全栈」以获取最新二维码。

    为确保交流群质量,防止营销广告人群混入,我们采取了此措施。望各位理解!

    公众号 交流群
    有来技术公众号二维码 交流群二维码

    项目简介

    🔥基于 vue3 + vite5 + typescript + element-plus 构建的后台管理系统(配套接口文档和后端源码)。vue-element-admin 的 vue3 版本。

    发行版本

    当前项目没有发行版本

    贡献者 22

    全部贡献者

    开发语言

    • Vue 58.7 %
    • TypeScript 37.3 %
    • JavaScript 2.8 %
    • SCSS 0.8 %
    • HTML 0.4 %