# QuickBuild

**Repository Path**: sometimes-very-gentle/custom-quick-build-platform

## Basic Information

- **Project Name**: QuickBuild
- **Description**: 帮助我们快速开发后台
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2022-11-03
- **Last Updated**: 2022-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

  <h1 align="center">QuickBuild</h1>
<p align="center">
<img src="https://img.shields.io/badge/jdk-1.8-blue.svg" /> 
<img src="https://img.shields.io/badge/springboot-2.2.2-red.svg" />
<img src="https://img.shields.io/badge/mysql-8.0-green.svg" />
<a src="https://blog.csdn.net/qq_37437493?spm=1003.2020.3001.5343"><img src="https://img.shields.io/badge/小庆-(〝▼皿▼)-green.svg" />💟</a>
</p>

## 架构体系（制作不易点一个star吧！）
  <h5 align="center">
<a href="http://121.5.136.8/login">在线预览</a>
</h5>

| 功能介绍        | 使用技术       | 文档地址                                                                                            | 特性注意事                       |
|-------------|------------|-------------------------------------------------------------------------------------------------|-----------------------------|
| 简化开发、提高效率而生 | mybatis-plus | [mybatis-plus官网](https://baomidou.com/pages/24112f/)                                            | 提高crud效率                    |
| 智能设计体系连接轻盈体验 | 字节（arco.design） | [arco.design官网](https://arco.design/vue/docs/start)                                             | 学习大厂语法结构方便维护                |
| 后端开发框架      | SpringBoot | [SpringBoot官网](https://spring.io/projects/spring-boot/#learn)                                   |                             |
| 权限认证        | sa-token   | [Sa-Token官网](https://sa-token.dev33.cn/doc/index.html#/)                                        | 轻量级 Java 权限认证框架，让鉴权变得简单、优雅！ |
| 代码生成器       | renren-generator | [Renren-Generator官网](https://gitee.com/renrenio/renren-generator)                               | 人人开源基础上增加了前端页面生成和请求生成       |
| 实体类自动生成表    | lq-entity-builder           | [lq-entity-builder 说明文档](https://www.yuque.com/docs/share/a904557d-fdde-4ca7-8589-c863385dd7a7) | 通过实体类生成相应的表再也不用创建表了         |
| 开启事务    | LqTransaction           | 业务加上@LqTransaction注解即可         |
| 加入文档在线预览功能    | 预览工具使用的是openOffice工具 | 可以自定义编写优化工具 支持doc docx ppt .... 进行预览        |
|  下版升级成微服务版！    | 下版升级成微服务版！ |   :collision: :collision: :collision: :collision:         |

![输入图片说明](https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/%E7%BD%91%E7%BB%9C%E6%8B%93%E6%89%91%E5%9B%BE%E6%A0%B7%E4%BE%8B.png)

## 模块说明 （超详细说明）

### lq-admin (核心模块)

```
    aop:日志
    config：
           corsConfig:跨越配置
           FileMaxConfig：文件上传大小配置
           GlobIException:全局异常配置
           Mylmage:文件映射配置
           RedisConfig:redis配置
           SatokenConfigure: sa-token权限认证配置
           StpInterfaceImpl：角色配置 需要的 小伙伴自行放开
           SwaggerConfig: 接口文档的配置
    exception:
           处理我们的sa-tokem的异常配置
    module:  模块
           lq:
              chatroom:
                       这个是利用neety写的聊天室接口（ 页面目前没有完善只有接口）
              sys： 系统利用到的接口
                  TchatStorageController: 
                                          聊天信息取口
                  TLogController:
                                 登录接口（验证码，登录，退出....）
                  TOnlineListingController：
                                           在线用户接口
                  TOssController:
                                  整合oss阿里对象储存：
                                                    请求流程: 
                                                             从后端拿到我们的上传凭证 返回给前端在去请求oss接口
                  TRoleController：
                                  角色接口
                  TRoutingController：
                                  路由接口
                  TChatStorageController：
                                        系统信息接口
                  TSysTestController：
                                     系统测试接口
                  TUserController：
                                  用户接口
                  UploadPictureController：
                                    文件上传接口
```

### lq-common (公共模块)

 ```
     config:
            FileConfig: 文件公共路径

     statuscode:
            TUserStatusCode：用户状态枚举
     
     utils: 
           Q: 返回实体类（熟悉的链式编程）
           ExcelUtils： 表格导出导入公共方法
           ImageUtil：图片上传
           OnlineTools: 获取ip
           PasswordEncryp： 密码加密和判断
           SysUtile ：系统信息获取
     
     xss:
           sql防止注入
```

### lq-constructor(代码生成器) 人人代码代码生成器 二开

```
     需要自定义代码生成器只需要在GenUtils的getFileName方法里面添加文件名
     写法按照其他模板的vm语法
``` 

### lq-mapper (dao层)

```
    config:
           Druid：数据源配置
           MyMetaObjectHandler：插入策略配置
    module：这里模板对应上面lq-admin的实体类
    utils：
           PageUtils：
                      分页创建
```

### lq-sql (数据库)

### lq-vue (前端)
| 系统功能 | 功能介绍 | 建议 |
|------|------|----|
|   管理员   |  管理用户和控制用户的状态    |    |
|   路由   | 控制路由的图标名称...    | 可以拓张其他路由信息   |
|   后台接口   |  swagge美化包    |   可以自定义 |
|   在线用户   |  目前就只可以踢人    |    |
|  日志   |  日志记录   |    |
|   文件   |  管理系统中的图片已经文件   |    |
### lq-vue (实体类生成表)

```
    annotation: 注解
    start： 核心类
    table： 创建表的辅助核心类
    type:   mysql的字段类型
```

#### 演示图例

<table border="1"  cellpadding="1" cellspacing="1" style="width:500px">
    <tbody>
        <tr>
            <td><img src="https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/image.png" width="1920" /></td>
            <td><img src="
https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/role.png" width="1920" /></td>
        </tr>
 <tr>
            <td><img src="
https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/imagess.png" width="1920" /></td>
            <td><img src="
https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/image2.png" width="1920" /></td>
        </tr>
 <tr>
            <td><img src="https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/router.png" width="1920" /></td>
            <td><img src="https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/sysUser.png" width="1920" /></td>
        </tr>
 <tr>
            <td><img src="https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/data.png" width="1920" /></td>
            <td><img src="
https://help-xiao.oss-cn-beijing.aliyuncs.com/lq/img/fileImg.png" width="1920" /></td>
        </tr>
    </tbody>
</table>

## 快速入门

### 第一步 导入lq-sql 刷新数据库看到object就ok

### 第二步  配置一下lq-admin下的数据库信息

### 第三步启动 后台

### 第四步 解压lq-vue的压缩包

### 第五步 进入文件夹下输入命令

> npm run dev
> 访问http:localhost:3000