README

RewardfulSpark 是一个小型库，允许您通过最小配置将 Laravel Spark 应用程序与 Rewardful 集成。

安装

首先，使用 Composer 需求 RewardfulSpark 包

composer require rewardful/rewardful-spark "3.*"

发布包

您可以通过运行此命令单独发布配置。

php artisan vendor:publish --tag=rewardful-config --force

您还可以使用此命令发布 Vue 组件

php artisan vendor:publish --tag=rewardful-vue --force

配置

在开始使用 RewardfulSpark 之前，您需要配置您的 API 密钥。将以下行添加到您的 .env 文件中。

REWARDFUL_API_KEY=<API_KEY>

前端

为了使 Rewardful 能够捕获您的推荐信息，您需要稍微调整您的 views 和 vue 文件。

Blade 布局

在您的 blade 布局中，您需要包含此 blade 指令，以便它在所有页面上体现。这将确保我们的 JavaScript 库正在监控所有传入的推荐。例如，在 app.blade.php 的底部添加以下行，在 </body> 标签之前。

@rewardful_js

Vue 组件

RewardfulSpark 伴随着一些小的 Vue 组件，这些组件与 register-stripe 和 subscribe-stripe 组件混合。根据您的配置，您可能需要更新这些文件。

Laravel Spark 7.0+

信用卡预付

如果您要求用户在注册时预先输入他们的信用卡详细信息

将 Vue 模块包含到您的 resources/js/spark-components/auth/register-stripe.js 中。假设是原始文件且未作修改，您的文件应如下所示。

var base = require('auth/register-stripe');
// include the module
var rewardful = require('../../rewardful/rewardful-register');

Vue.component('spark-register-stripe', {
	// add the module as mixing along with the base component
    mixins: [base, rewardful]
});

无信用卡预付

如果您不要求用户预先输入信用卡信息，并提供 GenericTrial，那么您需要确保在订阅过程中捕获 referral 代码。

将 Vue 模块包含到您的 resources/js/spark-components/settings/subscription/subscribe-stripe.js 中。假设是原始文件且未作修改，您的文件应如下所示。

var base = require('settings/subscription/subscribe-stripe');
// include the module
var rewardful = require('../../../rewardful/rewardful-register');

Vue.component('spark-subscribe-stripe', {
	// add the module as mixing along with the base component
    mixins: [base, rewardful]
});

Laravel Spark 5 & 6

信用卡预付

如果您要求用户在注册时预先输入他们的信用卡详细信息

将 Vue 模块包含到您的 resources/assets/js/spark-components/auth/register-stripe.js 中。假设是原始文件且未作修改，您的文件应如下所示。

var base = require('auth/register-stripe');
// include the module
var rewardful = require('../../../../js/rewardful/rewardful-register');

Vue.component('spark-register-stripe', {
	// add the module as mixing along with the base component
    mixins: [base, rewardful]
});

无信用卡预付

如果您不要求用户预先输入信用卡信息，并提供 GenericTrial，那么您需要确保在订阅过程中捕获 referral 代码。

将 Vue 模块包含到您的 resources/assets/js/spark-components/settings/subscription/subscribe-stripe.js 中。假设是原始文件且未作修改，您的文件应如下所示。

var base = require('settings/subscription/subscribe-stripe');
// include the module
var rewardful = require('../../../../../js/rewardful/rewardful-register');

Vue.component('spark-subscribe-stripe', {
	// add the module as mixing along with the base component
    mixins: [base, rewardful]
});

编译您的资源

为了使更改生效，您需要编译您的资源。运行与您的环境相关的命令。假设是生产构建

npm run production

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

致谢

Mina Abadir

许可证

MIT 许可证 (MIT)。请参阅许可证文件以获取更多信息。