diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..ac115304d4e22e94036e6de53ebb933c08cf9c92 --- /dev/null +++ b/README.en.md @@ -0,0 +1,51 @@ +This project is a backend service project developed using the Go language, primarily utilizing the Gin framework to build API services. The project contains multiple modules such as user management, express information management, dictionary type management, MacBook-related data management, and more. Additionally, the project integrates various middleware and services, including JWT authentication, logging, email sending, Redis caching, RabbitMQ message queuing, and others. + +## Features + +- **User Management**: Supports functionalities such as user creation, login, and information retrieval. +- **Express Information Management**: Supports operations for adding, deleting, editing, and querying express information. +- **Dictionary Type Management**: Supports paginated queries, saving, updating, and deletion of dictionary types. +- **MacBook Data Management**: Supports data management of MacBook and its related components (CPU, memory). +- **Test Express Service**: Supports batch saving and paginated querying of test express information. +- **File Upload and Download**: Supports file upload and download functionalities. +- **CAPTCHA Generation**: Supports generation of image CAPTCHAs and math CAPTCHAs. +- **Email Sending**: Supports email sending functionality. +- **JWT Authentication**: Supports user authentication based on JWT. +- **Logging**: Supports detailed request logging. +- **Redis Caching**: Supports data caching using Redis. +- **RabbitMQ Message Queue**: Supports asynchronous message processing using RabbitMQ. + +## Installation and Configuration + +1. **Environment Preparation**: Ensure the Go language environment is installed and GOPROXY is configured. +2. **Install Dependencies**: Run `go mod download` to install the required dependency packages for the project. +3. **Configuration File**: Modify the configuration information in `api/expressAPI/config/application.yml` as needed, including database connection, Redis configuration, RabbitMQ configuration, and more. +4. **Start the Service**: Run `go run api/expressAPI/main.go` to start the service. + +## Usage Instructions + +- **User Management**: Perform user creation, login, and other operations by accessing the corresponding API endpoints. +- **Express Information Management**: Perform add, delete, update, and query operations on express information by accessing the corresponding API endpoints. +- **Dictionary Type Management**: Perform paginated queries, saving, updating, and deletion of dictionary types by accessing the corresponding API endpoints. +- **MacBook Data Management**: Manage data for MacBook and its related components by accessing the corresponding API endpoints. +- **Test Express Service**: Perform batch saving and paginated querying of test express information by accessing the corresponding API endpoints. +- **File Upload and Download**: Perform file upload and download operations by accessing the corresponding API endpoints. +- **CAPTCHA Generation**: Generate image CAPTCHAs and math CAPTCHAs by accessing the corresponding API endpoints. +- **Email Sending**: Send emails by accessing the corresponding API endpoints. +- **JWT Authentication**: Perform JWT-based user authentication by accessing the corresponding API endpoints. +- **Logging**: Perform detailed request logging by accessing the corresponding API endpoints. +- **Redis Caching**: Perform data caching operations by accessing the corresponding API endpoints. +- **RabbitMQ Message Queue**: Perform asynchronous message processing by accessing the corresponding API endpoints. + +## Contribution Guide + +Code contributions and issue reports are welcome. Please follow the steps below: + +1. Fork the project repository. +2. Create a new branch. +3. Commit your changes. +4. Create a Pull Request. + +## License + +This project is licensed under the MIT License. For details, please refer to the LICENSE file located in the project root directory. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..df1837851cd0fbd5aad40cd3225fcdb981b26067 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +该项目是一个基于Go语言开发的后端服务项目,主要使用了Gin框架来构建API服务。项目包含了多个模块,如用户管理、快递信息管理、字典类型管理、MacBook相关数据管理等。此外,项目还集成了多种中间件和服务,如JWT鉴权、日志记录、邮件发送、Redis缓存、RabbitMQ消息队列等。 + +## 功能特性 + +- **用户管理**:支持用户的创建、登录、信息获取等功能。 +- **快递信息管理**:支持快递信息的增删改查操作。 +- **字典类型管理**:支持字典类型的分页查询、保存、更新和删除。 +- **MacBook数据管理**:支持MacBook及其相关组件(CPU、内存)的数据管理。 +- **测试快递服务**:支持测试快递信息的批量保存、分页查询等。 +- **文件上传下载**:支持文件的上传和下载功能。 +- **验证码生成**:支持生成图形验证码和数学验证码。 +- **邮件发送**:支持邮件的发送功能。 +- **JWT鉴权**:支持基于JWT的用户认证。 +- **日志记录**:支持详细的请求日志记录。 +- **Redis缓存**:支持使用Redis进行数据缓存。 +- **RabbitMQ消息队列**:支持使用RabbitMQ进行异步消息处理。 + +## 安装与配置 + +1. **环境准备**:确保已经安装了Go语言环境,并且配置好了GOPROXY。 +2. **依赖安装**:运行`go mod download`来安装项目所需的依赖包。 +3. **配置文件**:根据需要修改`api/expressAPI/config/application.yml`中的配置信息,包括数据库连接、Redis配置、RabbitMQ配置等。 +4. **启动服务**:运行`go run api/expressAPI/main.go`来启动服务。 + +## 使用说明 + +- **用户管理**:通过访问相应的API接口来进行用户的创建、登录等操作。 +- **快递信息管理**:通过访问相应的API接口来进行快递信息的增删改查操作。 +- **字典类型管理**:通过访问相应的API接口来进行字典类型的分页查询、保存、更新和删除操作。 +- **MacBook数据管理**:通过访问相应的API接口来进行MacBook及其相关组件的数据管理操作。 +- **测试快递服务**:通过访问相应的API接口来进行测试快递信息的批量保存、分页查询等操作。 +- **文件上传下载**:通过访问相应的API接口来进行文件的上传和下载操作。 +- **验证码生成**:通过访问相应的API接口来生成图形验证码和数学验证码。 +- **邮件发送**:通过访问相应的API接口来进行邮件的发送操作。 +- **JWT鉴权**:通过访问相应的API接口来进行基于JWT的用户认证操作。 +- **日志记录**:通过访问相应的API接口来进行详细的请求日志记录操作。 +- **Redis缓存**:通过访问相应的API接口来进行数据缓存操作。 +- **RabbitMQ消息队列**:通过访问相应的API接口来进行异步消息处理操作。 + +## 贡献指南 + +欢迎贡献代码和提出问题。请遵循以下步骤: + +1. Fork项目仓库。 +2. 创建新的分支。 +3. 提交你的更改。 +4. 创建Pull Request。 + +## 许可证 + +本项目采用MIT许可证。详情请查看项目根目录下的LICENSE文件。 \ No newline at end of file