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月前
|
JavaScript 数据可视化
vue-cli学习一:vue脚手架的 vue-cli2和vue-cli3版本 创建vue项目,vue的初始化详解
这篇文章介绍了如何使用vue-cli 2和3版本来创建Vue项目,并详细说明了两者之间的主要区别。
98 5
vue-cli学习一:vue脚手架的 vue-cli2和vue-cli3版本 创建vue项目,vue的初始化详解
|
2月前
|
JavaScript 容器
乾坤qiankun框架搭建 主应用为vue3的项目。
乾坤qiankun框架搭建 主应用为vue3的项目。
159 2
|
2月前
|
JavaScript
Vue CLi脚手架创建第一个VUE项目
Vue CLi脚手架创建第一个VUE项目
36 3
|
1月前
|
数据采集 监控 JavaScript
在 Vue 项目中使用预渲染技术
【10月更文挑战第23天】在 Vue 项目中使用预渲染技术是提升 SEO 效果的有效途径之一。通过选择合适的预渲染工具,正确配置和运行预渲染操作,结合其他 SEO 策略,可以实现更好的搜索引擎优化效果。同时,需要不断地监控和优化预渲染效果,以适应不断变化的搜索引擎环境和用户需求。
|
17天前
|
JavaScript 前端开发
如何在 Vue 项目中配置 Tree Shaking?
通过以上针对 Webpack 或 Rollup 的配置方法,就可以在 Vue 项目中有效地启用 Tree Shaking,从而优化项目的打包体积,提高项目的性能和加载速度。在实际配置过程中,需要根据项目的具体情况和需求,对配置进行适当的调整和优化。
|
2月前
|
JavaScript 数据可视化
vue-cli学习二:vue-cli3版本 创建vue项目后,Runtime-Compiler和Runtime-only两个模式详解;vue项目管理器;配置文件的配置在哪,以及如何配置
这篇文章详细介绍了Vue CLI 3版本创建项目时的Runtime-Compiler和Runtime-only两种模式的区别、Vue程序的运行过程、render函数的使用、eslint的关闭方法,以及Vue CLI 2和3版本配置文件的不同和脚手架3版本创建项目的配置文件配置方法。
55 3
vue-cli学习二:vue-cli3版本 创建vue项目后,Runtime-Compiler和Runtime-only两个模式详解;vue项目管理器;配置文件的配置在哪,以及如何配置
|
2月前
|
JavaScript
如何在 Vue 项目中选择合适的模块格式
【10月更文挑战第20天】选择合适的模块格式需要综合考虑多个因素,没有一种绝对正确的选择。需要根据项目的具体情况进行权衡和分析。在实际选择过程中,要保持灵活性,根据项目的发展和变化适时调整模块格式。
21 7
|
29天前
Vue3 项目的 setup 函数
【10月更文挑战第23天】setup` 函数是 Vue3 中非常重要的一个概念,掌握它的使用方法对于开发高效、灵活的 Vue3 组件至关重要。通过不断的实践和探索,你将能够更好地利用 `setup` 函数来构建优秀的 Vue3 项目。
|
2月前
|
JavaScript 前端开发 编译器
在 Vue 项目中使用 ES 模块格式的优点
【10月更文挑战第20天】在 Vue 项目中使用 ES 模块格式具有众多优点,这些优点共同作用,使得项目能够更高效、更可靠地开发和运行。当然,在实际应用中,还需要根据项目的具体情况和需求进行合理的选择和配置。
33 6
|
29天前
|
JavaScript 测试技术 UED
解决 Vue 项目中 Tree shaking 无法去除某些模块
【10月更文挑战第23天】解决 Vue 项目中 Tree shaking 无法去除某些模块的问题需要综合考虑多种因素,通过仔细分析、排查和优化,逐步提高 Tree shaking 的效果,为项目带来更好的性能和用户体验。同时,持续关注和学习相关技术的发展,不断探索新的解决方案,以适应不断变化的项目需求。