vue3-element-admin 项目说明文档

简介: vue3-element-admin 项目说明文档

项目介绍

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


项目有以下特性:


基于 vue-element-admin 升级到 vue3 版本,无自定义封装,易上手,减少学习成本。

提供了配套的 Java 后端接口,真实的接口数据,而非使用 Mock 数据。您可以访问在线接口文档查看接口详情。

权限系统功能齐全,包括用户管理、角色管理、菜单管理、字典管理和部门管理等,以满足您对权限管理的需求。

项目还提供了基础设施支持,包括动态路由、按钮级别的权限控制、国际化支持、代码规范、Git 提交规范以及常用组件的封装,以便开发人员更高效地开发和维护项目。

项目预览

在线预览: https://vue3.youlai.tech/


控制台

微信图片_20230710112635.png



接口文档

微信图片_20230710112652.png



权限管理系统

微信图片_20230710112704.png微信图片_20230710112707.png微信图片_20230710112711.png微信图片_20230710112713.png



项目地址

项目 Gitee                       Github                        GitCode

前端 vue3-element-admin vue3-element-admin vue3-element-admin

后端 youlai-boot                     youlai-boot             youlai-boot

环境准备

环境

名称版本

备注

开发工具

VSCode

下载地址

运行环境

NODE16+

下载地址

VSCode插件(必装)

1. Vue Language Features (Volar)

2. TypeScript Vue Plugin (Volar)

3. 禁用 Vetur

微信图片_20230710113117.png



项目启动

# 克隆代码

git clone https://gitee.com/youlaiorg/vue3-element-admin.git

# 安装 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地址

}

}


注意事项

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


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


微信图片_20230710113150.png


项目启动浏览器访问空白


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


项目同步仓库更新升级


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


其他问题


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


接口支持

接口调用地址:https://vapi.youlai.tech


接口文档地址:在线接口文档


OpenAPI文档地址:http://vapi.youlai.tech/v3/api-docs


本地接口:默认使用线上接口,你可以通过以下步骤完成本地接口环境搭建:


获取基于 Java 、SpringBoot 开发的后端 youlai-boot 源码 ;

根据后端工程说明文档 README.md 完成本地启动;

替换 vite.config.ts 的代理目标地址 vapi.youlai.tech 为本地的 localhost:8989

项目文档

基于 Vue3 + Vite4 + TypeScript + Element-Plus 从0到1搭建后台管理系统


ESLint+Prettier+Stylelint+EditorConfig 约束和统一前端代码规范


Husky + Lint-staged + Commitlint + Commitizen + cz-git 配置 Git 提交规范


提交规范

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


微信图片_20230710113209.png

相关文章
|
2天前
|
JSON 数据可视化 数据库
vue3+threejs+koa可视化项目——实现登录注册(第三步)
vue3+threejs+koa可视化项目——实现登录注册(第三步)
43 5
|
2天前
|
数据可视化 前端开发 JavaScript
vue3+threejs可视化项目——引入threejs加载钢铁侠模型(第二步)
vue3+threejs可视化项目——引入threejs加载钢铁侠模型(第二步)
80 3
|
2天前
|
JavaScript 数据可视化 算法
vue3+threejs可视化项目——搭建vue3+ts+antd路由布局(第一步)
vue3+threejs可视化项目——搭建vue3+ts+antd路由布局(第一步)
38 6
|
1天前
|
监控 JavaScript 前端开发
Vue 项目性能优化指南:提升应用速度与效率
Vue 项目性能优化指南:提升应用速度与效率
|
1天前
|
JavaScript Go
VUE3+vite项目中动态引入组件和异步组件
VUE3+vite项目中动态引入组件和异步组件
|
2天前
|
Web App开发 编解码 JavaScript
【Vue篇】Vue 项目下载、介绍(详细版)
【Vue篇】Vue 项目下载、介绍(详细版)
10 3
|
2天前
|
资源调度 JavaScript 前端开发
vue 项目运行过程中出现错误的问题解决
vue 项目运行过程中出现错误的问题解决
13 1
|
2天前
|
JavaScript
vue项目切换页面白屏的解决方案
vue项目切换页面白屏的解决方案
10 0
|
2天前
|
XML JavaScript 前端开发
Vue3 项目中怎么使用 jsx——易懂
Vue3 项目中怎么使用 jsx——易懂
8 0
|
2天前
|
缓存 JavaScript API
一些常见的Vue项目性能优化策略
【5月更文挑战第8天】Vue项目性能优化包括代码分割、懒加载以减少初次加载时间;利用计算属性和侦听器处理复杂逻辑;优化v-for,使用key属性;减少DOM操作;借助Vue Devtools分析性能;图片优化如使用WebP格式和懒加载;异步加载组件;精简第三方库和插件;考虑服务端渲染或预渲染;以及优化网络请求,如合并请求和利用缓存。实际应用中,需根据项目需求选择合适策略。
17 2