README

此Laravel包的目标是通过服务、外观和方法简化与Facebook的Whatsapp Business API的集成，并且正确地记录如何使用它，因为有时很难找到您需要的信息来正确实现API。

在Packagist上查看我们的包。

项目标准

[WIP]

项目元数据

项目状态

[WIP]

目录

• Composer脚本
• 运行和测试
• 配置Whatsapp Webhook
• 工具
  • Comitzen
  • 示例应用
  • Serveo
• 贡献者
• 变更日志
• 路线图

Composer脚本

我们尽可能地自动化了在短composer脚本上的无聊任务和CLI命令。以下是对每个脚本的一般描述

• composer commit：运行comitzen二进制文件，它打开一个交互式CLI，以便将提交保持在一个标准，我们的管道可以使用它来自动生成包变更日志。
• composer coverage：运行测试并生成代码覆盖率。如果您正在贡献，请确保不要降低当前的覆盖率。 ;)
• composer start：通过php artisan serve命令加载包后，提供示例应用程序（通过composer serve）。它将在端口8000上运行示例应用。
• composer serve：连接到Serveo服务并公开您的本地环境。它假定本地应用正在端口8000上运行。
• composer test：运行测试（不生成覆盖率报告）

运行和测试

我们包含了一个新的Laravel示例应用，以帮助那些想要为包做出贡献的人。要启动它，请按照以下步骤操作

1. 克隆此存储库并将cd进入示例应用文件夹（<repository-folder>/samples/laravel-11）。
2. 从存储库根目录运行composer setup。它将在示例应用文件夹中cd，安装依赖项并将cd回到根文件夹。
3. 从存储库根目录运行composer start。它将通过artisan serve命令运行示例应用。
4. 在本地服务器运行的情况下，在另一个终端中从存储库运行composer serve。它将连接到serveo服务并将您的本地应用程序公开到网络上。

配置Whatsapp Webhook

[WIP]

工具

除了源代码外，我们还提供了一些工具，以减轻遵循我们设置的图案和标准以及自动化一些无聊过程的负担。

Comitizen

这个CLI帮助以有意义和标准化的方式编写提交消息，以便我们的自动化流程可以使用它们正确地编写我们的软件变更日志。

如果您喜欢这个工具，请给开发者点赞 ;)

如何使用Comitizen

只需从存储库根目录运行composer commit而不是传统的git commit，然后按照CLI交互步骤操作 :)

示例应用

对于那些想要测试和/或为此包做出贡献的人来说，我们已经包含了一个带有本地已加载的包的示例新鲜 Laravel 应用程序，这样您就可以模拟使用此包的真实 Laravel 应用程序：

如何运行示例应用

只需从存储库的根目录运行 composer serve。脚本将进入示例文件夹，并从那里运行 Laravel artisan 命令 php artisan serve。

Serveo

此服务允许将外部请求路由到您的本地环境。您可以在开发过程中使用它来本地测试您的 Watsapp webooks。

如果您喜欢这个工具，给开发者点个赞 ;)

如何使用 Serveo

只需从存储库的根目录运行 composer connect。您需要让我们的示例应用程序运行，这样您就可以接收本地 webhook 请求。

贡献者

感谢所有亲爱的贡献者。没有他们，一切都不可能实现 ❤️

您想在这里看到您的个人资料吗？请查看我们的 行为准则 和我们的 贡献指南，然后开始编码！我们非常乐意审查您提交的 PR！💯

返回顶部

变更日志

自开发开始以来，对此包所做的所有更改都可以在我们的 发布列表 或 变更日志 中找到。

返回顶部

路线图

任何计划增强包的功能都将在此 项目页面 中描述和跟踪。

返回顶部