mirror of
https://gitee.com/youlaitech/youlai-mall.git
synced 2024-12-22 20:54:26 +08:00
docs(README.md): 优化项目说明文档
This commit is contained in:
parent
009592c6a5
commit
2436c63092
51
README.md
51
README.md
@ -1,11 +1,24 @@
|
|||||||
![](https://img.shields.io/badge/youlai--mall-v2.0.0-blue) ![](https://img.shields.io/badge/SpringBoot-2.6.3-brightgreen.svg) ![](https://img.shields.io/badge/SpringCloud-2021-green.svg) [![](https://img.shields.io/github/stars/youlaitech/youlai-mall.svg?style=social&label=Stars)](https://github.com/youlaitech/youlai-mall) [![](https://gitee.com/youlaitech/youlai-mall/badge/star.svg)](https://gitee.com/youlaiorg/youlai-mall) [![](https://img.shields.io/badge/Author-有来开源组织-orange.svg)](https://gitee.com/youlaiorg) [![](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://gitee.com/youlaitech/youlai-mall/blob/master/LICENSE)
|
<div align="center">
|
||||||
|
<img src="https://img.shields.io/badge/SpringBoot-2.6.3-brightgreen.svg"/>
|
||||||
|
<img src="https://img.shields.io/badge/SpringCloud-2021-green.svg"/>
|
||||||
|
<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">
|
||||||
|
<img src="https://gitee.com/youlaitech/youlai-mall/badge/star.svg"/>
|
||||||
|
</a>
|
||||||
|
<img src="https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg"/>
|
||||||
|
<a href="https://gitee.com/youlaiorg" target="_blank">
|
||||||
|
<img src="https://img.shields.io/badge/Author-有来开源组织-orange.svg"/>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
|
|
||||||
<p align="center">
|
<div align="center">
|
||||||
<a target="_blank" href="https://gitee.com/youlaiorg"> Gitee 仓库</a> |
|
<a target="_blank" href="https://gitee.com/youlaiorg"> Gitee 仓库</a> |
|
||||||
<a target="_blank" href="https://gitee.com/youlaitech"> Github 仓库</a> |
|
<a target="_blank" href="https://gitee.com/youlaitech"> Github 仓库</a> |
|
||||||
<a target="_blank" href="https://www.cnblogs.com/haoxianrui/"> 博客主页</a> |
|
<a target="_blank" href="https://www.cnblogs.com/haoxianrui/"> 博客主页</a> |
|
||||||
<a target="_blank" href="http://youlaitech.gitee.io/youlai-mall"> 官方文档</a>
|
<a target="_blank" href="http://youlaitech.gitee.io/youlai-mall"> 官方文档</a>
|
||||||
</p>
|
</div>
|
||||||
|
|
||||||
# 📚️ 项目介绍
|
# 📚️ 项目介绍
|
||||||
|
|
||||||
@ -20,23 +33,23 @@
|
|||||||
|
|
||||||
- 项目使用皆是当前主流的技术栈,无过度自定义封装,易理解学习和二次扩展;
|
- 项目使用皆是当前主流的技术栈,无过度自定义封装,易理解学习和二次扩展;
|
||||||
- SpringBoot 2.6、SpringCloud 2021 & Alibaba 2021 一站式微服务开箱即用的解决方案;
|
- SpringBoot 2.6、SpringCloud 2021 & Alibaba 2021 一站式微服务开箱即用的解决方案;
|
||||||
- Spring Security OAuth2 、 Spring Cloud Gateway 、 JWT 统一认证鉴权逻辑和常用授权模式扩展;
|
- Spring Security OAuth2 、 Spring Cloud Gateway 、 JWT 统一认证鉴权和常用 OAuth2 授权模式扩展;
|
||||||
- 移动端采用终极跨平台解决方案 uni-app, 一套代码编译iOS、Android、H5和小程序等多个平台;
|
- 移动端采用终极跨平台解决方案 uni-app, 一套代码编译iOS、Android、H5和小程序等多个平台;
|
||||||
- Jenkins、Docker、K8s实现微服务持续集成与交付(CI/CD)。
|
- Jenkins、K8s、Docker实现微服务持续集成与交付(CI/CD)。
|
||||||
|
|
||||||
### 🗀 在线预览
|
### 🗀 在线预览
|
||||||
|
|
||||||
- Vue3: [www.youlai.tech](http://www.youlai.tech)
|
| Vue3| Vue2 | H5| 微信小程序|
|
||||||
- Vue2: [www.youlai.tech:9527](http://www.youlai.tech:9527)
|
| --- | --- | --- |--- |
|
||||||
- H5:[www.youlai.tech:81](http://www.youlai.tech:9527)
|
| [www.youlai.tech](http://www.youlai.tech) | [www.youlai.tech:9527](http://www.youlai.tech:9527) | [www.youlai.tech:81](http://www.youlai.tech:9527)| 加我微信申请体验|
|
||||||
- 小程序: 加我微信申请体验
|
|
||||||
|
|
||||||
### 🗀 预览截图
|
### 🗀 预览截图
|
||||||
|
|
||||||
| 【App】Spring Security OAuth2 手机短信验证码模式 | 【小程序】Spring Security OAuth2 微信授权模式 |
|
|「App」Spring Security OAuth2 手机短信验证码模式 | 「小程序」Spring Security OAuth2 微信授权模式 |
|
||||||
| ------------------------------------------------------------ | :----------------------------------------------------------- |
|
| ------------------------------------------------------------ |----------------------------------------------------------- |
|
||||||
| <img src="https://gitee.com/haoxr/image/raw/master/default/smscode%20(1).gif" width="100%" height="400px"/> | <img src="https://gitee.com/haoxr/image/raw/master/default/wechatlogin.gif" width="100%" height="400px"/> |
|
| <img src="https://gitee.com/haoxr/image/raw/master/default/smscode%20(1).gif" width="100%" height="400px"/> | <img src="https://gitee.com/haoxr/image/raw/master/default/wechatlogin.gif" width="100%" height="400px"/> |
|
||||||
| **【管理系统】Spring Security OAuth2 密码模式** | **【管理系统】Spring Security OAuth2 验证码模式** |
|
| **「管理前端」Spring Security OAuth2 密码模式** | **「管理前端」Spring Security OAuth2 验证码模式** |
|
||||||
| <img src="https://gitee.com/haoxr/image/raw/master/default/password.gif" width="100%" height="400px"/> | <img src="https://gitee.com/haoxr/image/raw/master/default/captcha.gif" width="100%" height="400px"/> |
|
| <img src="https://gitee.com/haoxr/image/raw/master/default/password.gif" width="100%" height="400px"/> | <img src="https://gitee.com/haoxr/image/raw/master/default/captcha.gif" width="100%" height="400px"/> |
|
||||||
|
|
||||||
# ⛺ 源码地址
|
# ⛺ 源码地址
|
||||||
@ -50,7 +63,7 @@
|
|||||||
|
|
||||||
# 🚤 项目启动
|
# 🚤 项目启动
|
||||||
|
|
||||||
### 🗀 后端启动
|
### 🗀 后端
|
||||||
|
|
||||||
> `极速启动` 是方便快速启动查看效果的启动方式,其中的数据库和Redis等中间件使用的是有来提供的云环境,切勿修改数据,有时间条件建议`本地启动`。
|
> `极速启动` 是方便快速启动查看效果的启动方式,其中的数据库和Redis等中间件使用的是有来提供的云环境,切勿修改数据,有时间条件建议`本地启动`。
|
||||||
|
|
||||||
@ -130,7 +143,11 @@
|
|||||||
|
|
||||||
输入用户名/密码:nacos/nacos ;
|
输入用户名/密码:nacos/nacos ;
|
||||||
|
|
||||||
进入管控台,点击左侧菜单 `配置管理` → `配置列表` 进入列表页面,点击 `导入配置` 选择项目中的 `doc/nacos/DEFAULT_GROUP.zip` 文件 。
|
进入管控台,点击左侧菜单 `配置管理` → `配置列表` 进入列表页面,点击 `导入配置` 选择项目中的 `doc/nacos/DEFAULT_GROUP.zip` 文件 ;
|
||||||
|
|
||||||
|
4. **修改Nacos配置**
|
||||||
|
|
||||||
|
进入共享配置 `youlai-common.yaml` ,修改 MySQL、Redis、RabbitMQ等中间件信息为您自己本地环境,默认为有来云环境。
|
||||||
|
|
||||||
|
|
||||||
4. **服务启动**
|
4. **服务启动**
|
||||||
@ -147,14 +164,14 @@
|
|||||||
|
|
||||||
访问接口文档地址测试 [http://localhost:9999/doc.html](http://localhost:9999/doc.html)
|
访问接口文档地址测试 [http://localhost:9999/doc.html](http://localhost:9999/doc.html)
|
||||||
|
|
||||||
### 🗀 管理前端启动
|
### 🗀 管理前端
|
||||||
|
|
||||||
1. 本机安装 Node 环境
|
1. 本机安装 Node 环境
|
||||||
2. npm install
|
2. npm install
|
||||||
3. npm run dev
|
3. npm run dev
|
||||||
4. 访问 http://localhost:9527
|
4. 访问 http://localhost:9527
|
||||||
|
|
||||||
### 🗀 微信小程序启动
|
### 🗀 微信小程序
|
||||||
|
|
||||||
1. 下载 `HBuilder X` 和 `微信开发者工具` ;
|
1. 下载 `HBuilder X` 和 `微信开发者工具` ;
|
||||||
2. 导入 [mall-app](https://gitee.com/youlaitech/youlai-mall-weapp) 源码至 `HBuilder X` ;
|
2. 导入 [mall-app](https://gitee.com/youlaitech/youlai-mall-weapp) 源码至 `HBuilder X` ;
|
||||||
@ -164,7 +181,7 @@
|
|||||||
6. Nacos控制台替换 `youlai-auth` 配置中的微信小程序 AppID 和 AppSecret 为自己申请的小程序 ;
|
6. Nacos控制台替换 `youlai-auth` 配置中的微信小程序 AppID 和 AppSecret 为自己申请的小程序 ;
|
||||||
7. `Hbuilder X` 工具栏点击 `运行` -> `运行到小程序模拟器` -> `微信开发者工具`。
|
7. `Hbuilder X` 工具栏点击 `运行` -> `运行到小程序模拟器` -> `微信开发者工具`。
|
||||||
|
|
||||||
### 🗀 移动端启动
|
### 🗀 H5/移动端
|
||||||
|
|
||||||
1. 下载 `HBuilder X` ;
|
1. 下载 `HBuilder X` ;
|
||||||
2. 导入 [mall-app](https://gitee.com/youlaitech/youlai-mall-weapp) 源码至 `HBuilder X`;
|
2. 导入 [mall-app](https://gitee.com/youlaitech/youlai-mall-weapp) 源码至 `HBuilder X`;
|
||||||
|
Loading…
Reference in New Issue
Block a user