hvent90/spark

Laravel Spark 为 Laravel SaaS 应用程序提供启动脚手架。

1 2016-03-02 18:42 UTC

This package is not auto-updated.

Last update: 2024-09-17 03:21:41 UTC


README

介绍

Spark 是一个 alpha、实验性版本。功能会改变,可能会出现错误。感谢您测试!

Spark 是一个实验性项目,主要用于构建面向商业的 SaaS 应用程序,并对该用例有强烈的看法。

安装

首先,安装 Spark 安装程序,并确保全局 Composer bin 目录在您的系统 $PATH 中。

	composer global require "laravel/spark-installer=~1.0"

接下来,创建一个新的 Laravel 应用程序并安装 Spark。

	laravel new application

	cd application

	spark install

安装 Spark 后,请确保迁移您的数据库,安装 NPM 依赖项,并运行 gulp 命令。您还应在 .env 文件中设置 AUTHY_KEYSTRIPE_KEYSTRIPE_SECRET 环境变量。

您还可以查看在您的应用程序中安装的 SparkServiceProvider 类。此提供者是自定义 Spark 安装的中心位置。

定义订阅计划

订阅计划可以在您的 app/Providers/SparkServiceProvider.php 文件中定义。此文件包含一个 customizeSubscriptionPlans 方法。在此方法中,您可以定义应用程序的所有订阅计划。方法中有几个示例以供您开始。

定义 Spark 计划时,plan 方法接受两个参数:计划名称和计划的 Stripe ID。请确保传递给 plan 方法的 Stripe ID 与您的 Stripe 账户上的计划 ID 相对应。

	Spark::plan('Display Name', 'stripe-id')
		->price(10)
		->features([
			//
		]);

年度计划

要定义年度计划,只需在计划定义上调用 yearly 方法。

	Spark::plan('Basic', 'basic-yearly')
		->price(100)
		->yearly()
		->features(
			//
		);

优惠券

要使用优惠券,只需在 Stripe 上创建优惠券,并通过带有与 Stripe 上优惠券 ID 匹配的 coupon 查询字符串变量的 /register 路由访问。

    http://stripe.app/register?coupon=code

您可以使用 Spark::promotion 方法在您的 SparkServiceProvider 中运行网站范围的促销活动。

	Spark::promotion('coupon-code');

团队

要启用团队,只需在您的 User 模型上使用 CanJoinTeams 特性。特性已在文件顶部导入,因此您只需将其添加到模型本身即可。

	class User extends Model implements TwoFactorAuthenticatableContract,
	                                    BillableContract,
	                                    CanResetPasswordContract
	{
	    use Billable, CanJoinTeams, CanResetPassword, TwoFactorAuthenticatable;
	}

一旦启用团队,注册时将需要团队名称,并在用户设置仪表板中可用 Teams 选项卡。

角色

团队角色可以在 SparkServiceProvidercustomizeRoles 方法中定义。

自定义 Spark 视图

您可以通过使用 vendor:publish 命令发布 Spark 的常见 Blade 视图。

	php artisan vendor:publish --tag=spark-basics

所有发布的视图将放在 resources/views/vendor/spark 中。

如果您想发布所有 Spark 视图,您可以使用 spark-full 标签。

	php artisan vendor:publish --tag=spark-full

自定义 Spark JavaScript

resources/assets/js/core/components.js 文件包含加载一些常用 Spark Vue 组件的语句。Vue 是 Spark 注册和设置屏幕所使用的 JavaScript 框架。

您可以将这些 require 语句中的任何一项更改为您自己的 Vue 组件,以便为特定屏幕加载。您很可能会将原始组件复制为自定义的起点。