From f7e055d11142d6fc42d1e7f91dc0f8a4d711c4c8 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Mon, 25 Aug 2025 08:09:35 +0000
Subject: [PATCH] Update README.md

---
 README.en.md |  95 ++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 196 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..49e12d0
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,95 @@
+
+
+# nw-java-boot
+
+`nw-java-boot` is a microservice project based on Spring Boot, designed to provide a unified development framework for complex business scenarios involving multiple tenants, multiple channels, and multiple applications. The project covers multiple modules including permission management, payment system, user management, and configuration management, making it suitable for building enterprise-level applications.
+
+## Project Structure
+
+- **Auth Module**: Permission management module, including management of roles, functions, and resources.
+- **Pay Module**: Payment system module, supporting various payment methods (WeChat, Alipay, etc.), including payment transactions and refund functionalities.
+- **Profile Module**: Configuration management module, supporting basic configurations for tenants, applications, channels, dictionaries, and more.
+- **User Module**: User management module, including management of users, addresses, and login credentials.
+- **Common Module**: Contains general components such as constants, utility classes, and base entity classes.
+
+## Functional Modules
+
+### Permission Management (auth)
+- Role Management: Supports create, read, update, and delete (CRUD) operations for roles.
+- Function Management: Supports management of functional menus.
+- Resource Management: Supports configuration of resource permissions.
+
+### Payment System (pay)
+- Payment Configuration: Supports configuration for multiple payment methods.
+- Payment Transactions: Manages payment transaction records.
+- Refund Management: Supports refund requests and status tracking.
+- Payment Adapters: Supports integration with third-party payment platforms such as WeChat and Alipay.
+
+### Configuration Management (profile)
+- Tenant Management: Supports tenant configurations under a multi-tenant architecture.
+- Application Management: Supports management of multiple applications.
+- Channel Management: Supports channel configurations, such as WeChat official accounts, mini-programs, etc.
+- Dictionary Management: Supports system dictionary configuration.
+
+### User Management (user)
+- User Management: Supports user registration, login, and information management.
+- Address Management: Supports management of users' shipping addresses.
+- Login Credential Management: Supports management of user login credentials.
+
+## Technology Stack
+
+- **Spring Boot**: Rapid microservice development.
+- **Spring Data JPA**: Database access layer.
+- **Spring Security / JWT**: Permission control and authentication.
+- **Redis / Redisson**: Cache management.
+- **MyBatis / MyBatis Plus**: Optional database access solutions.
+- **Swagger / SpringDoc**: API documentation generation.
+- **Lombok**: Simplifies Java code writing.
+- **Maven**: Project building and dependency management.
+
+## Quick Start
+
+### Environment Requirements
+- JDK 1.8 or later
+- Maven 3.x
+- MySQL 5.7 or later
+- Redis
+
+### Build and Run
+
+1. **Clone the project**
+   ```bash
+   git clone https://gitee.com/team-nw/nw-java-boot.git
+   ```
+
+2. **Enter the project directory**
+   ```bash
+   cd nw-java-boot
+   ```
+
+3. **Build the project**
+   ```bash
+   mvn clean install
+   ```
+
+4. **Run the project**
+   ```bash
+   mvn spring-boot:run
+   ```
+
+5. **Access the API Documentation**
+   ```
+   http://localhost:8080/swagger-ui.html
+   ```
+
+## Contribution Guide
+
+We welcome code contributions and documentation improvements. Please follow these steps:
+1. Fork the project.
+2. Create a new branch.
+3. Submit your code changes.
+4. Create a Pull Request.
+
+## License
+
+This project is released under the [MIT License](https://opensource.org/licenses/MIT).
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2258bdc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,101 @@
+该项目中未找到现有的 `README.md` 文件内容。根据项目结构和代码内容，我可以为您生成一个符合项目需求的 `README.md` 文件。以下是该项目的 `README.md` 内容建议：
+
+---
+
+# nw-java-boot
+
+`nw-java-boot` 是一个基于 Spring Boot 的微服务项目，旨在为多租户、多渠道、多应用的复杂业务场景提供统一的开发框架。项目涵盖了权限管理、支付系统、用户管理、配置管理等多个模块，适用于构建企业级应用。
+
+## 项目结构
+
+- **auth 模块**：权限管理模块，包含角色、功能、资源的管理。
+- **pay 模块**：支付系统模块，支持多种支付方式（微信、支付宝等），包含支付流水、退款等功能。
+- **profile 模块**：配置管理模块，支持租户、应用、渠道、字典等基础配置。
+- **user 模块**：用户管理模块，包含用户、地址、登录凭证等管理功能。
+- **公共模块**：包含常量、工具类、基础实体类等通用组件。
+
+## 功能模块
+
+### 权限管理 (auth)
+- 角色管理：支持角色的增删改查。
+- 功能管理：支持功能菜单的管理。
+- 资源管理：支持资源权限的配置。
+
+### 支付系统 (pay)
+- 支付配置：支持多种支付方式的配置。
+- 支付流水：管理支付交易记录。
+- 退款管理：支持退款申请与状态查询。
+- 支付适配器：支持微信、支付宝等第三方支付平台的对接。
+
+### 配置管理 (profile)
+- 租户管理：支持多租户架构下的租户配置。
+- 应用管理：支持多应用的管理。
+- 渠道管理：支持渠道配置，如微信公众号、小程序等。
+- 字典管理：支持系统字典配置。
+
+### 用户管理 (user)
+- 用户管理：支持用户的注册、登录、信息管理。
+- 地址管理：支持用户的收货地址管理。
+- 登录凭证管理：支持用户登录凭证的管理。
+
+## 技术栈
+
+- **Spring Boot**：快速构建微服务。
+- **Spring Data JPA**：数据库访问层。
+- **Spring Security / JWT**：权限控制与认证。
+- **Redis / Redisson**：缓存管理。
+- **MyBatis / MyBatis Plus**：可选的数据库访问方案。
+- **Swagger / SpringDoc**：API 文档生成。
+- **Lombok**：简化 Java 代码编写。
+- **Maven**：项目构建与依赖管理。
+
+## 快速开始
+
+### 环境要求
+- JDK 1.8 或更高版本
+- Maven 3.x
+- MySQL 5.7 或更高版本
+- Redis
+
+### 构建与运行
+
+1. **克隆项目**
+   ```bash
+   git clone https://gitee.com/team-nw/nw-java-boot.git
+   ```
+
+2. **进入项目目录**
+   ```bash
+   cd nw-java-boot
+   ```
+
+3. **构建项目**
+   ```bash
+   mvn clean install
+   ```
+
+4. **运行项目**
+   ```bash
+   mvn spring-boot:run
+   ```
+
+5. **访问 API 文档**
+   ```
+   http://localhost:8080/swagger-ui.html
+   ```
+
+## 贡献指南
+
+欢迎贡献代码和改进文档。请遵循以下步骤：
+1. Fork 项目。
+2. 创建新分支。
+3. 提交代码更改。
+4. 提交 Pull Request。
+
+## 许可证
+
+本项目采用 [MIT License](https://opensource.org/licenses/MIT) 开源协议。
+
+--- 
+
+如需进一步定制或补充内容，请告知具体需求。
\ No newline at end of file
-- 
Gitee