Skip to content
This repository has been archived by the owner on Jan 3, 2020. It is now read-only.

faustbrian-archives/laravel-rewardable

Repository files navigation

Laravel Rewardable

Build Status PHP from Packagist Latest Version License

Installation

Require this package, with Composer, in the root directory of your project.

$ composer require artisanry/rewardable

To get started, you'll need to publish the vendor assets and migrate:

php artisan vendor:publish --provider="Artisanry\Rewardable\RewardableServiceProvider" && php artisan migrate

Usage

Setup a Model

<?php


namespace App;

// use Artisanry\Rewardable\Badges\HasBadges;
// use Artisanry\Rewardable\Credits\HasCredits;
// use Artisanry\Rewardable\Ranks\HasRanks;
// use Artisanry\Rewardable\Transactions\HasTransactions;
use Artisanry\Rewardable\HasRewardsTrait;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use HasRewards;

    // these can be required one-by-one if you don't need all and don't use HasRewards
    // use HasBadges;
    // use HasCredits;
    // use HasRanks;
    // use HasTransactions;
}

Testing

$ phpunit

Security

If you discover a security vulnerability within this package, please send an e-mail to hello@basecode.sh. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute.

License

Mozilla Public License Version 2.0 (MPL-2.0).