From 6ee66a825c6a06499e6def1ef6f702759854e118 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Tue, 30 Sep 2025 02:48:49 +0000 Subject: [PATCH] Update README.md --- README.md | 93 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 56 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index ceb4275..51aa51a 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,67 @@ # Laravel接口框架V8.5.x -#### 介绍 -Laravel接口框架V8.5.x +## 介绍 +这是一个基于 Laravel 8.5.x 构建的接口框架，适用于快速搭建前后端分离的应用。框架集成了多种常用组件和服务，包括消息队列、文件存储、数据库操作、搜索功能等，旨在提供一个高效稳定的后端开发基础。 -#### 软件架构 -包含前后端接口 +## 软件架构 +- **接口服务**：提供前后端交互的API接口。 +- **消息队列**：支持多种消息队列模式（如 Work、Fanout、Direct、Topic 等）。 +- **文件处理**：支持本地、MinIO 和阿里云 OSS 的文件上传与管理。 +- **数据库支持**：集成 MySQL、MongoDB 和 Elasticsearch，支持多种数据存储方式。 +- **缓存机制**：使用 Redis 和 MongoDB 作为缓存解决方案。 +- **RPC 通信**：提供 JSON-RPC 支持远程调用。 +- **WebSocket 支持**：集成 Socket.IO 客户端与服务端通信。 +- **数据处理**：支持 CSV、Excel 和 ZIP 文件的生成与解析。 +## 安装教程 +1. 使用 Composer 安装依赖： + ```bash + composer install + ``` -#### 安装教程 +2. 安装必要的扩展包： + ```bash + composer require alibabacloud/dysmsapi-20170525 + composer require aliyuncs/oss-sdk-php + composer require aws/aws-sdk-php-laravel + composer require bschmitt/laravel-amqp + composer require dingo/api + composer require elasticsearch/elasticsearch + composer require intervention/image + composer require jaeger/querylist + composer require league/csv + composer require mongodb/mongodb + composer require php-amqplib/php-amqplib + composer require phpoffice/phpspreadsheet + composer require predis/predis + composer require tymon/jwt-auth + ``` -1. composer install -2. composer require alibabacloud/dysmsapi-20170525 -3. composer require aliyuncs/oss-sdk-php -4. composer require aws/aws-sdk-php-laravel -5. composer require bschmitt/laravel-amqp -6. composer require dingo/api -7. composer require elasticsearch/elasticsearch -8. composer require intervention/image -9. composer require jaeger/querylist -10. composer require league/csv -11. composer require mongodb/mongodb -12. composer require php-amqplib/php-amqplib -13. composer require phpoffice/phpspreadsheet -14. composer require predis/predis -15. composer require tymon/jwt-auth +3. 配置 `.env` 文件以匹配你的开发、测试或生产环境。 -#### 使用说明 +4. 运行迁移和种子填充（如适用）： + ```bash + php artisan migrate + php artisan db:seed + ``` -1. http://dev.api.laravel-8.5.itrident.cn/api/front -2. http://dev.api.laravel-8.5.itrident.cn/mgr/front +## 使用说明 +- **前端接口**：访问 `http://dev.api.laravel-8.5.itrident.cn/api/front` 获取前端 API 文档。 +- **管理后台接口**：访问 `http://dev.api.laravel-8.5.itrident.cn/mgr/front` 获取管理后台 API 文档。 -#### 参与贡献 +## 参与贡献 +1. Fork 本仓库。 +2. 新建 Feat_xxx 分支。 +3. 提交代码。 +4. 新建 Pull Request。 -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +## 特技 +1. 使用 `Readme_XXX.md` 来支持不同的语言，例如 `Readme_en.md`, `Readme_zh.md`。 +2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)。 +3. 探索 Gitee 上的优秀开源项目 [https://gitee.com/explore](https://gitee.com/explore)。 +4. GVP（Gitee 最有价值开源项目）[https://gitee.com/gvp](https://gitee.com/gvp)。 +5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)。 +6. Gitee 封面人物展示会员风采 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)。 - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +## 许可证 +本项目遵循 MIT 许可证，请查看项目中的 LICENSE 文件以获取更多信息。 \ No newline at end of file -- Gitee