furic / redeem-codes
用于创建兑换码以补偿用户或在进行活动时给予奖励的兑换码系统。
1.0.9
2020-12-23 23:47 UTC
Requires
- php: ^7.2
- laravel/framework: ~5.8||~6.0||~7.0||~8.0
README
Laravel 5.* 的兑换码生成器和兑换工具。我在为 Sweaty Chair Studio 的工作中开发了这个包,为玩家提供补偿和活动奖励。这个包包含了兑换码验证的API和一个简单的Web控制台,用于创建和编辑兑换码。这个包旨在成为即插即用型的解决方案,我也推荐 Laravel Promocodes 和 Laravel Vouchers,它们能给你更多自由,并允许你从头开始构建。
目录
安装
通过Composer安装此包
$ composer require furic/redeem-codes
如果您正在使用Laravel 5.5或更高版本,则安装完成。否则,请按照以下步骤操作。
打开 config/app.php
并按照以下步骤操作
找到 providers
数组并添加我们的服务提供者。
'providers' => [ // ... Furic\RedeemCodes\RedeemCodesServiceProvider::class ],
配置
使用Artisan命令发布配置和迁移文件
$ php artisan vendor:publish
要创建数据库中的兑换码表,请运行
$ php artisan migrate
使用
Web控制台
安装完成后,您可以直接浏览到 <服务器URL>
/redeem-codes 打开Web控制台
在这里,您可以浏览、创建和编辑兑换码。
兑换码参数
- 代码前缀:设置兑换码的前缀,用于更容易区分或与活动名称相关联。请注意,所有兑换码的长度均为固定12个字符。
- 可重用性:设置兑换码是否可重复使用于不同玩家。请注意,服务器不会检查同一用户是否多次兑换,您应该在客户端应用程序中添加检查以防止这种情况。
- 数量:要创建的兑换码数量。
- 描述:兑换码的描述。
- 奖励:奖励类型和数量,您可以在这里添加多个奖励。奖励类型只是一个小的整型,应该在客户端应用程序中转换为枚举。要添加或更改奖励类型,只需编辑 index.blade.php 文件。
兑换验证API
GET <服务器URL>/api/redeem/{code}
将兑换码(12个字符长度)发送到服务器,并返回兑换码数据。对于有效的兑换码,返回状态码200和兑换码JSON数据。否则,返回状态码400和错误信息。
API文档可以在 这里 找到。
Unity客户端仓库
您可以将 此仓库 导入Unity,以使用此包与您的Laravel服务器进行通信。
待办事项
- 在配置文件中添加可配置的项目类型。
- 为Web控制台添加管理员登录。
- 添加测试和工厂。
- 添加兑换历史页面(已在数据库中)。
- 添加可重用服务器检查(优先级低)。
许可证
laravel-redeem-codes 在 MIT许可证 下授权。