README

Laravel VSL Data Center is a VSL Data Center PHP SDK bridge for Laravel.

Installation

This package requires PHP ^8.1 and supports Laravel 10 and above.

You can install the package via composer by running:

composer require velocity-sports-labs/datacenter-laravel-sdk

After the installation has completed, the package will automatically register itself. Run the following to publish the config file

php artisan vendor:publish --provider="VelocitySportsLabs\DataCenter\DataCenterServiceProvider"

This creates a config/vsl-datacenter.php config file with contents like:

<?php

return [
    'api_base' => env('VSL_DATA_CENTER_BASE_URL', ''),

    'api_key' => env('VSL_DATA_CENTER_KEY'),

    'origin' => env('VSL_DATA_CENTER_ORIGIN'),

    'user_agent' => env('VSL_DATA_CENTER_USER_AGENT', ''),
];

Do not worry about the api_base and user_gent keys, but it is advisable to set the user_agent key. In your .env file, you can set the VSL_DATA_CENTER_USER_AGENT environment variable as below

VSL_DATA_CENTER_USER_AGENT="${APP_NAME}"

Usage

Here you can see an example of just how simple this package is to use. After you enter your authentication details in the config file, it will just work:

use VelocitySportsLabs\DataCenter\DataCenter;

DataCenter::countries()->list();
// we're done here - how easy was that, it just works!
// this example is simple, and there are far more methods available

The DataCenter facade is bound to the `` class behind the scenes. For more information on how to use the class, check out the docs at https://github.com/velocitysportslabs/datacenter-php-sdk,

Testing

Run the tests with:

vendor/bin/pest

Roadmap

Here are a list of outstanding tasks to do:

add tests

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail abdulkudus2922@gmail.com instead of using the issue tracker.

Credits

License

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

velocity-sports-labs / datacenter-laravel-sdk

Maintainers

Details