https://github.com/digikraaft/laravel-dashboard-paystack-customers-tile
A tile to show list of Paystack Customers on Laravel Dashboard
https://github.com/digikraaft/laravel-dashboard-paystack-customers-tile
digikraaft laravel laravel-dashboard laravel-dashboard-tile paystack paystack-dashboard php
Last synced: 6 months ago
JSON representation
A tile to show list of Paystack Customers on Laravel Dashboard
- Host: GitHub
- URL: https://github.com/digikraaft/laravel-dashboard-paystack-customers-tile
- Owner: digikraaft
- License: mit
- Created: 2020-08-08T19:51:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T06:00:32.000Z (almost 6 years ago)
- Last Synced: 2024-04-22T11:07:12.674Z (over 2 years ago)
- Topics: digikraaft, laravel, laravel-dashboard, laravel-dashboard-tile, paystack, paystack-dashboard, php
- Language: PHP
- Homepage:
- Size: 184 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# A tile to show list of Paystack Customers on Laravel Dashboard
[](https://scrutinizer-ci.com/g/digikraaft/laravel-dashboard-paystack-customers-tile/build-status/master)
[](https://scrutinizer-ci.com/g/digikraaft/laravel-dashboard-paystack-customers-tile/?branch=master)
[](https://scrutinizer-ci.com/code-intelligence)
[](https://opensource.org/licenses/MIT)
This tile displays the list of [Paystack](https://paystack.com) customers.
It can be used on [the Laravel Dashboard](https://docs.spatie.be/laravel-dashboard).
## Installation
You can install the package via composer:
```bash
composer require digikraaft/laravel-dashboard-paystack-customers-tile
```
You need to publish the migrations and config file of the [Laravel Dashboard](https://github.com/spatie/laravel-dashboard) package.
In the `dashboard` config file, you can optionally add this configuration in the tiles key and customize it for your own needs:
```
// in config/dashboard.php
'tiles' => [
/**
* Paystack configuration settings
*/
'paystack' => [
'secret_key' => env('PAYSTACK_SECRET'),
'customers' => [
/**
* the values here must be supported by the Paystack API
* @link https://paystack.com/docs/api/#customer-list
*/
'params' => [
'perPage' => 100,
'from' => now()->subMonths(3)->toDateString(),
'to' => now()->toDateString(),
],
/**
* How often should the data be refreshed in seconds
*/
'refresh_interval_in_seconds' => 1800,
],
],
],
```
You must set your `PAYSTACK_SECRET` in the `.env` file. You can get this from your Paystack dashboard.
To load the customer data from Paystack, you need to schedule the `FetchCustomersDataFromPaystackApi`
command:
```
// in app/Console/Kernel.php
use Digikraaft\PaystackCustomersTile\FetchCustomersDataFromPaystackApi;
protected function schedule(Schedule $schedule)
{
$schedule->command(FetchCustomersDataFromPaystackApi::class)->twiceDaily();
}
```
You can change the frequency of the schedule as desired. You can also use the
`php artisan dashboard:fetch-customers-data-from-paystack-api` command.
## Usage
In your dashboard view you use the `livewire:paystack-customers-tile` component.
```html
```
You can add an optional title:
```html
```
## Pagination
The package paginates data by default. The default value is 5. This can be changed by adding a `perPage`
property to the tile:
```html
```
## Testing
Use the command below to run your tests:
``` bash
composer test
```
## More Good Stuff
Check [here](https://github.com/digikraaft) for more awesome free stuff!
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email dev@digitalkraaft.com instead of using the issue tracker.
## Credits
- [Tim Oladoyinbo](https://github.com/timoladoyinbo)
- [All Contributors](../../contributors)
## Thanks to
- [Spatie](https://github.com/spatie/) for the [Laravel Dashboard](https://github.com/spatie/laravel-dashboard) package
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.