diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..eac455d78881c8aa96bc78ca414693555bc415be --- /dev/null +++ b/README.en.md @@ -0,0 +1,66 @@ +# YueYou Project Documentation + +This is a project based on a microservices architecture, consisting of multiple modules suitable for cloud deployment and service discovery. The project uses the Spring Boot and Spring Cloud frameworks and supports service gateway and user service modules. + +## Project Structure + +- **common**: Common module containing the base class Main. +- **gateway**: Gateway module used to handle service routing and distribution. +- **user-service**: User service module that provides user-related business functionality. +- **pom.xml**: Maven project configuration file used for managing dependencies and modules. + +## Key Features + +- **Service Discovery**: Supports service registration and discovery through the `@EnableDiscoveryClient` annotation. +- **Gateway Functionality**: Provides a unified API entry point and manages request routing. +- **User Service**: Implements user management functions and supports database operations. + +## Installation and Deployment + +### System Requirements + +- Java 8 or higher +- Maven 3.x +- Spring Boot 2.x + +### Build Steps + +1. Clone the project to your local machine: + ```bash + git clone https://gitee.com/four-groups_8/yueyou.git + ``` + +2. Enter the project directory and build: + ```bash + cd yueyou + mvn clean install + ``` + +3. Start the services: + - Start the gateway service: + ```bash + cd gateway + mvn spring-boot:run + ``` + - Start the user service: + ```bash + cd ../user-service + mvn spring-boot:run + ``` + +## Usage Instructions + +- After the gateway service starts, it listens on port `8080` by default. +- After the user service starts, it listens on port `8081` by default. +- Access the user service API endpoints through the gateway. + +## Contribution Guidelines + +Code contributions and project improvements are welcome. Please follow these steps: +1. Fork the project. +2. Create a new branch. +3. Submit a Pull Request. + +## License + +This project is licensed under the MIT License. For details, please refer to the LICENSE file. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..8439508916fd7db295e0aba060a825114a8f92bd --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# YueYou 项目说明 + +这是一个基于微服务架构的项目,包含多个模块,适用于云端部署和服务发现。项目使用 Spring Boot 和 Spring Cloud 架构,支持服务网关和用户服务模块。 + +## 项目结构 + +- **common**:通用模块,包含基础类 Main。 +- **gateway**:网关模块,用于处理服务路由和分发。 +- **user-service**:用户服务模块,提供用户相关的业务功能。 +- **pom.xml**:Maven 项目配置文件,用于管理依赖和模块。 + +## 主要功能 + +- **服务发现**:通过 `@EnableDiscoveryClient` 注解支持服务注册与发现。 +- **网关功能**:提供统一的 API 入口,管理请求路由。 +- **用户服务**:实现用户管理功能,支持数据库操作。 + +## 安装与部署 + +### 环境要求 + +- Java 8 或更高版本 +- Maven 3.x +- Spring Boot 2.x + +### 构建步骤 + +1. 克隆项目到本地: + ```bash + git clone https://gitee.com/four-groups_8/yueyou.git + ``` + +2. 进入项目目录并构建: + ```bash + cd yueyou + mvn clean install + ``` + +3. 启动服务: + - 启动网关服务: + ```bash + cd gateway + mvn spring-boot:run + ``` + - 启动用户服务: + ```bash + cd ../user-service + mvn spring-boot:run + ``` + +## 使用说明 + +- 网关服务启动后,默认监听端口为 `8080`。 +- 用户服务启动后,默认监听端口为 `8081`。 +- 通过网关访问用户服务的 API 接口。 + +## 贡献指南 + +欢迎贡献代码和改进项目。请遵循以下步骤: +1. Fork 项目。 +2. 创建新分支。 +3. 提交 Pull Request。 + +## 许可证 + +本项目遵循 MIT 许可证。详情请查看 LICENSE 文件。 \ No newline at end of file