README.md 5.1 KB
Newer Older
1
<p align="center">
2 3 4
    <img src="https://img.shields.io/badge/Vue-3.2.25-brightgreen.svg"/>
    <img src="https://img.shields.io/badge/Vite-2.9.7-green.svg"/>
    <img src="https://img.shields.io/badge/Element Plus-2.1.8-blue.svg"/>
5 6 7 8
    <a src="https://github.com/hxrui" target="_blank">
        <img src="https://img.shields.io/github/stars/youlaitech/youlai-mall.svg?style=social&label=Stars"/>
    </a>
    <a href="https://gitee.com/youlaitech/youlai-mall" target="_blank">
9
        <img src="https://gitee.com/youlaiorg/vue3-element-admin/badge/star.svg"/>
10 11
    </a> 
    <br/>
12
    <img src="https://img.shields.io/badge/license-MIT-green.svg"/>
13 14 15 16 17
    <a href="https://gitee.com/youlaiorg" target="_blank">
        <img src="https://img.shields.io/badge/Author-有来开源组织-orange.svg"/>
    </a>
</p>
<p align="center">
18
<a target="_blank" href="http://vue3.youlai.tech">在线预览</a> |  <a target="_blank" href="https://www.youlai.tech/pages/5d571c/">官方文档</a> 
19
</p>
20

21
## 项目介绍
22

23
[vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) 是基于 [vue-element-admin](https://gitee.com/panjiachen/vue-element-admin) 升级的 Vue3 版本后台管理前端解决方案;使用前端主流技术栈 Vue3 + Vite2 + TypeScript + Vue Router + Pinia + Volar + Element Plus 等;实现功能包括不限于动态权限路由、按钮权限控制、国际化、主题大小切换等;基于此模板开发了有来商城管理系统,也是有来开源组织的另一项开源力作。
24

25 26
## 项目优势

27 28
- 基于 vue-element-admin 升级的 Vue3 版本 ,极易上手,减少学习成本;
- 一套完整适配的微服务权限系统线上接口,企业级真实前后端接入场景,非 Mock 数据;
29
- 功能全面:国际化、动态路由、按钮权限、主题大小切换、Echart、wangEditor;
30
- TypeScript 全面支持,包括组件和 API 调用层面;
31
- 主流 Vue3 生态和前端技术栈,常用组件极简封装;
32
- 从 0 到 1 的项目文档支持;
33 34 35

## 技术栈

36 37 38 39 40
| 技术栈 | 描述 | 官网 |
| --- | --- | --- |
| Vue3 | 渐进式 JavaScript 框架 | https://v3.cn.vuejs.org/ |
| TypeScript | JavaScript 的一个超集 | https://www.tslang.cn/ |
| Vite2 | 前端开发与构建工具 | https://cn.vitejs.dev/ |
41
| Element Plus | 基于 Vue 3,面向设计师和开发者的组件库 | https://element-plus.gitee.io/zh-CN/ |
42 43
| Pinia | 新一代状态管理工具 | https://pinia.vuejs.org/ |
| Vue Router | Vue.js 的官方路由 | https://router.vuejs.org/zh/ |
44 45 46

## 项目预览

47
在线预览地址: [vue3.youlai.tech](http://vue3.youlai.tech)
48

49 50
| ![控制台](https://s2.loli.net/2022/04/07/fIEDs3GeSb8rxlt.png) | ![国际化](https://s2.loli.net/2022/04/07/lt6u2jMefpTJvkh.gif) |
| --- | --- |
51 52
| ![菜单管理](https://s2.loli.net/2022/04/07/quTeB3pNIyQ4alG.png) | ![角色管理](https://s2.loli.net/2022/04/07/dmh5MYtuONGRJZn.png) |
| ![商品管理](https://s2.loli.net/2022/04/07/5XgYfMqBxhtdcG2.png) | ![库存设置](https://s2.loli.net/2022/04/07/s9IJeP7vRxq2WSL.png) |
53

54 55
## 项目地址

56 57
|  | Gitee | Github |
| --- | --- | --- |
58
| vue3-element-admin | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) |
郝先瑞 已提交
59
| 后端工程(非必要) | [youlai_boot](https://gitee.com/youlaiorg/youlai-boot) |  |
60

61
## 启动部署
62 63 64 65 66

### 环境准备

- 安装 Node

67
  版本:v14 或 v16
68 69 70

- 开发工具

71
  推荐 VSCode
72 73 74

- 必装插件

75
  VSCode 插件市场搜索并安装 Volar, 且一定要禁用 Vetur,不然代码会出现组件使用了但编译器还报组件未使用的警告信息,另外尤大也在 Vue3 生态话题说过 Volar 将会替代 Vetur 作为 Vue 的官方插件。
76 77 78 79 80

### 项目启动

1. npm install
2. npm run dev
郝先瑞 已提交
81
3. 浏览器访问 http://localhost:3000
82

83
### 项目部署
84

85 86 87 88 89 90 91
- 本地打包

  ```
  npm run build:prod
  ```

  生成的静态文件位于项目根目录 dist 文件夹下
92

93 94 95 96
- 上传文件

  创建 `/usr/local/nginx/html/vue3` 目录,将打包生成 dist 的所有文件拷贝至此工作目录下

97
- nginx.cofig 配置
98

99 100 101 102
  ```
  server {
      listen     80;
      server_name  localhost;
103

104
      location / {
105
          root /usr/local/nginx/html/vue3;
106 107
          index index.html index.htm;
      }
108

109 110
      # 代理转发请求至网关,prod-api标识解决跨域问题
      location /prod-api/ {
111
          proxy_pass http://sapi.youlai.tech/;
112 113
      }
  }
114

115
  ```
郝先瑞 已提交
116
## 本地接口
117

郝先瑞 已提交
118
> 如果你了解一些Java后端SpringBoot,可以轻松在本地搭建接口环境.
119 120 121 122 123 124 125

1. 访问后端项目仓库地址:https://gitee.com/youlaiorg/youlai-boot.git

2. 根据项目说明文档 [README.md](https://gitee.com/youlaiorg/youlai-boot#%E9%A1%B9%E7%9B%AE%E8%BF%90%E8%A1%8C) 的描述完成数据库的创建和后端工程的启动;
3. 进入 [vite.config.ts](vite.config.ts) 文件修改代理地址 http://sapi.youlai.tech 为 http://localhost:8989 ,启动前端工程即可。


126

127
## 联系信息
128

129
> 欢迎添加开发者微信,备注「有来」进群,备注「无回」参与开发
130

131
| ![郝先瑞](https://s2.loli.net/2022/04/06/yRx8uzj4emA5QVr.jpg) | ![张川](https://s2.loli.net/2022/04/06/cQihGv9uPsTjXk1.jpg) |
132
| --- | --- |