# quick-framework

**Repository Path**: oxy-projects/quick-framework

## Basic Information

- **Project Name**: quick-framework
- **Description**: 🫧用于快速创建Spring项目应用。
依赖：quick-tools。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-29
- **Last Updated**: 2025-04-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: quick, 开源

## README

= {project-name} image:favicon.ico["icon", 50,link=""]
:project-name: Quick Framework
:gitee-oxy: https://gitee.com/oxy-projects
:gitee: {gitee-oxy}/quick-pom
:jdk-version: 17

== 介绍

{project-name} 尽最大努力减少业务项目开发的不便捷性，提供项目基础的工具类及企业通用的项目架构。

项目主要目标是:

* 支持业务项目快速开发
* 集成 https://spring.io/[Spring] 最新功能
* 标准化



== 模块

{project-name} 中有多个模块。这里是一个快速概述:

- *quick-framework-lang*：##依赖``quick-tools-basic``。## 除此外主要包含``HTTP请求工具``、``请求&响应类``、``枚举类``。
- *quick-framework-mybatis*：##依赖``quick-framework-lang``。## 除此外主要包含``MyBatis配置``、``JDBC驱动``。
- *quick-framework*：##依赖``quick-framework-lang``。## 除此外主要包含``SpringBoot``、``日志``、``参数校验类``。
- *quick-framework-api*：##依赖``quick-framework``。## 除此外主要包含``spring-web``相关。
- *quick-tools-mybatis*：##依赖``quick-framework-mybatis``。## 除此外包含``Mybatis逆向工程``、``MybatisPlus逆向工程``，代码生成目录在``target/generated-mybatis-classes/``。


== 使用说明

首先需要保证你的本地环境满足：

* JDK >= {jdk-version}
* Maven 构建工具



== 开始

=== 1. 安装父POM

1. 克隆 {gitee-oxy}/quick-pom[Quick Pom] 项目
2. 本地安装

[source,shell]
----
# 进入项目
cd ${QuickPom项目路径}

# 安装POM到本地
mvn clean install
----


=== 2. 安装工具包

1. 克隆 {gitee-oxy}/quick-tools[Quick Tools] 项目
2. 本地安装

[source,shell]
----
# 进入项目
cd ${QuickTools项目路径}

# 安装JAR到本地
mvn clean install -DskipTests
----



== 获取帮助

如果在使用上有问题，希望下面可以帮助你：

* 通过提交 {gitee}/issues[issue] 来反馈你的问题或上报 {project-name} 的bugs.



== 提交issues
{project-name} 使用 gitee 的集成问题跟踪系统来记录bug和功能请求。
如果你想提出问题，请遵循以下建议:

* 在你记录一个bug之前，请搜索 {gitee}/issues[issue tracker]，看看是否有人已经报告了这个问题。
* 如果问题不存在请 {gitee}/issues/new[创建新问题]。
* 请随问题报告提供尽可能多的信息。
我们想知道您正在使用的 {project-name} 版本、操作系统和JVM版本。
* 如果需要粘贴代码或包含堆栈跟踪，请使用Markdown。
在文本前后用 +++```+++ 转义。
* 如果可以的话，尝试创建一个复现问题的测试用例或项目，并将其附加到问题上。



== License

{project-name} 是基于 https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license] 的开源软件。

[source]
----
面朝大海，春暖花开
-- 海子

从明天起，做一个幸福的人
喂马，劈柴，周游世界
从明天起，关心粮食和蔬菜
我有一所房子，面朝大海，春暖花开

从明天起，和每一个亲人通信
告诉他们我的幸福
那幸福的闪电告诉我的
我将告诉每一个人

给每一条河每一座山取一个温暖的名字
陌生人，我也为你祝福
愿你有一个灿烂的前程
愿你有情人终成眷属
愿你在尘世获得幸福
我只愿面朝大海，春暖花开
----