docs(README.md): 项目说明文档修改
This commit is contained in:
郝先瑞
parent
690ff90eb7
commit
561ed5975e
116
README.md
116
README.md
|
|
@ -15,7 +15,7 @@
|
|||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<strong>在线预览：</strong><a target="_blank" href="http://www.youlai.tech">www.youlai.tech</a>
|
||||
<strong>在线预览：</strong><a target="_blank" href="http://www.youlai.tech">www.youlai.tech</a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -25,54 +25,49 @@
|
|||
|
||||
## 项目介绍
|
||||
|
||||
[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 等；实现功能包括不限于动态权限路由、按钮权限控制、国际化、主题大小切换等；基于此模板开发了有来商城管理系统，也是有来开源组织的另一项开源力作。
|
||||
[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 等；实现功能包括不限于动态权限路由、按钮权限控制、国际化、主题大小切换等；基于此模板开发了有来商城管理系统，也是有来开源组织的另一项开源力作。
|
||||
|
||||
## 项目优势
|
||||
|
||||
- 基于 vue-element-admin 升级的Vue3版本 ，极易上手，减少学习成本；
|
||||
- 一套完整适配的微服务权限系统线上接口，企业级真实前后端接入场景，非Mock数据；
|
||||
- 基于 vue-element-admin 升级的 Vue3 版本 ，极易上手，减少学习成本；
|
||||
- 一套完整适配的微服务权限系统线上接口，企业级真实前后端接入场景，非 Mock 数据；
|
||||
- 功能全面：国际化、动态路由、按钮权限、主题大小切换、Echart、wangEditor；
|
||||
- TypeScript 全面支持，包括组件和API调用层面；
|
||||
- TypeScript 全面支持，包括组件和 API 调用层面；
|
||||
- 主流 Vue3 生态和前端技术栈，常用组件极简封装；
|
||||
- 从0到1的项目文档支持；
|
||||
- 全栈技术支持: 微服务接口、Vue3管理前端、uni-app移动端和K8S持续集成交付；
|
||||
|
||||
- 从 0 到 1 的项目文档支持；
|
||||
- 全栈技术支持: 微服务接口、Vue3 管理前端、uni-app 移动端和 K8S 持续集成交付；
|
||||
|
||||
## 技术栈
|
||||
|
||||
|
||||
| 技术栈 | 描述 | 官网 |
|
||||
| ---- | ---- | ---- |
|
||||
| Vue3 | 渐进式 JavaScript 框架 | https://v3.cn.vuejs.org/ |
|
||||
| TypeScript | JavaScript 的一个超集 | https://www.tslang.cn/
|
||||
| Vite2 | 前端开发与构建工具 | https://cn.vitejs.dev/ |
|
||||
| Element Plus | 基于 Vue 3，面向设计师和开发者的组件库 | https://element-plus.gitee.io/zh-CN/|
|
||||
| Pinia | 新一代状态管理工具 | https://pinia.vuejs.org/
|
||||
| Vue Router | Vue.js 的官方路由 |https://router.vuejs.org/zh/
|
||||
|
||||
|
||||
| 技术栈 | 描述 | 官网 |
|
||||
| --- | --- | --- |
|
||||
| Vue3 | 渐进式 JavaScript 框架 | https://v3.cn.vuejs.org/ |
|
||||
| TypeScript | JavaScript 的一个超集 | https://www.tslang.cn/ |
|
||||
| Vite2 | 前端开发与构建工具 | https://cn.vitejs.dev/ |
|
||||
| Element Plus | 基于 Vue 3，面向设计师和开发者的组件库 | https://element-plus.gitee.io/zh-CN/ |
|
||||
| Pinia | 新一代状态管理工具 | https://pinia.vuejs.org/ |
|
||||
| Vue Router | Vue.js 的官方路由 | https://router.vuejs.org/zh/ |
|
||||
|
||||
## 项目预览
|
||||
|
||||
在线预览地址: [www.youlai.tech](http://www.youlai.tech)
|
||||
|
||||
|  |  |
|
||||
| ----| ----|
|
||||
| |  |
|
||||
| |  |
|
||||
|
||||
| --- | --- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
## 项目地址
|
||||
|
||||
| |Gitee| Github| GitCode |
|
||||
| ---- | ----| ---- | ---- |
|
||||
| 开源组织 | [有来开源组织](https://gitee.com/youlaiorg) | [有来开源组织](https://github.com/youlaitech) | [有来开源组织](https://gitcode.net/youlai) |
|
||||
| 技术团队 | [有来技术团队](https://gitee.com/youlaitech) | [有来技术团队](https://github.com/youlaitech) | - |
|
||||
| 商城后端 | [youlai-mall](https://gitee.com/youlaiorg/youlai-mall)| [youlai-mall](https://github.com/youlaitech/youlai-mall) | [youlai-mall](https://gitcode.net/youlai/youlai-mall) |
|
||||
| 商城管理前端(Vue3)| [mall-admin-web](https://gitee.com/youlaiorg/mall-admin-web) | [mall-admin-web](https://github.com/youlaitech/mall-admin-web) | [mall-admin-web](https://gitcode.net/youlai/mall-admin-web) |
|
||||
| 商城管理前端(Vue2)| [mall-admin-web](https://gitee.com/youlaitech/youlai-mall-admin/tree/vue2/) | [mall-admin-web](https://github.com/youlaitech/mall-admin-web/tree/vue2/) | - |
|
||||
| 小程序/H5/移动端 | [mall-app](https://gitee.com/youlaiorg/mall-app)| [mall-app](https://github.com/youlaitech/mall-app) | [mall-app](https://gitcode.net/youlai/mall-app) |
|
||||
| vue3-element-admin| [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) |-|
|
||||
| | Gitee | Github | GitCode |
|
||||
| --- | --- | --- | --- |
|
||||
| 开源组织 | [有来开源组织](https://gitee.com/youlaiorg) | [有来开源组织](https://github.com/youlaitech) | [有来开源组织](https://gitcode.net/youlai) |
|
||||
| 技术团队 | [有来技术团队](https://gitee.com/youlaitech) | [有来技术团队](https://github.com/youlaitech) | - |
|
||||
| 商城后端 | [youlai-mall](https://gitee.com/youlaiorg/youlai-mall) | [youlai-mall](https://github.com/youlaitech/youlai-mall) | [youlai-mall](https://gitcode.net/youlai/youlai-mall) |
|
||||
| 商城管理前端(Vue3) | [mall-admin-web](https://gitee.com/youlaiorg/mall-admin-web) | [mall-admin-web](https://github.com/youlaitech/mall-admin-web) | [mall-admin-web](https://gitcode.net/youlai/mall-admin-web) |
|
||||
| 商城管理前端(Vue2) | [mall-admin-web](https://gitee.com/youlaitech/youlai-mall-admin/tree/vue2/) | [mall-admin-web](https://github.com/youlaitech/mall-admin-web/tree/vue2/) | - |
|
||||
| 小程序/H5/移动端 | [mall-app](https://gitee.com/youlaiorg/mall-app) | [mall-app](https://github.com/youlaitech/mall-app) | [mall-app](https://gitcode.net/youlai/mall-app) |
|
||||
| vue3-element-admin | [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) | - |
|
||||
|
||||
## 启动部署
|
||||
|
||||
|
|
@ -80,15 +75,15 @@
|
|||
|
||||
- 安装 Node
|
||||
|
||||
版本：v14 或 v16
|
||||
版本：v14 或 v16
|
||||
|
||||
- 开发工具
|
||||
|
||||
推荐 VSCode
|
||||
推荐 VSCode
|
||||
|
||||
- 必装插件
|
||||
|
||||
VSCode 插件市场搜索并安装 Volar, 且一定要禁用 Vetur，不然代码会出现组件使用了但编译器还报组件未使用的警告信息，另外尤大也在Vue3生态话题说过 Volar 将会替代 Vetur 作为 Vue 的官方插件。
|
||||
VSCode 插件市场搜索并安装 Volar, 且一定要禁用 Vetur，不然代码会出现组件使用了但编译器还报组件未使用的警告信息，另外尤大也在 Vue3 生态话题说过 Volar 将会替代 Vetur 作为 Vue 的官方插件。
|
||||
|
||||
### 项目启动
|
||||
|
||||
|
|
@ -98,42 +93,41 @@
|
|||
|
||||
🚨 如果安装依赖或启动报错，可尝试将依赖包 `/docs/node_modules.zip` 解压到项目根目录。
|
||||
|
||||
|
||||
### 项目部署
|
||||
|
||||
- 本地打包
|
||||
|
||||
```
|
||||
npm run build:prod
|
||||
```
|
||||
生成的静态文件位于项目根目录 dist 文件夹下
|
||||
- 本地打包
|
||||
|
||||
```
|
||||
npm run build:prod
|
||||
```
|
||||
|
||||
生成的静态文件位于项目根目录 dist 文件夹下
|
||||
|
||||
- nginx.cofig 配置
|
||||
|
||||
```
|
||||
server {
|
||||
listen 80;
|
||||
server_name localhost;
|
||||
```
|
||||
server {
|
||||
listen 80;
|
||||
server_name localhost;
|
||||
|
||||
location / {
|
||||
root /usr/share/nginx/html/web;
|
||||
index index.html index.htm;
|
||||
}
|
||||
location / {
|
||||
root /usr/share/nginx/html/web;
|
||||
index index.html index.htm;
|
||||
}
|
||||
|
||||
# 代理转发请求至网关，prod-api标识解决跨域问题
|
||||
location /prod-api/ {
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_pass http://www.youlai.tech:9999/;
|
||||
}
|
||||
}
|
||||
# 代理转发请求至网关，prod-api标识解决跨域问题
|
||||
location /prod-api/ {
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_pass http://www.youlai.tech:9999/;
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
## 联系信息
|
||||
|
||||
> 欢迎添加开发者微信，备注「有来」进群
|
||||
|
||||
|
||||
|  | |
|
||||
| ---- | ---- |
|
||||
|  |  |
|
||||
| --- | --- |
|
||||
|
|
|
|||
Loading…
Reference in New Issue