flavorly/wallet

A simple wallet system for your user

v0.1.5-alpha 2024-10-06 22:48 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

A dead simple yet secure & safe wallet for eloquent models.

Installation

You can install the package via composer:

composer require flavorly/wallet

You can publish and run the migrations with:

php artisan vendor:publish --tag="wallet-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="wallet-config"

This is the contents of the published config file:

return [
    'decimal_places' => 10,
    'currency' => 'USD',
    'columns' => [
        'balance' => 'wallet_balance',
        'credit' => 'wallet_credit',
    ]
];

Usage

use Flavorly\Wallet\Concerns\InteractsWithWallet;
use Flavorly\Wallet\Contracts\HasWallet;

class User extends Model implements HasWallet
{
    use InteractsWithWallet;
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.