tallesairan/laravel-valueserp

Easily work with the Valueserp API in a Laravel application.

1.2 2023-07-19 21:10 UTC

Requires

• php: >=7.4
• guzzlehttp/guzzle: >=7.4
• illuminate/support: >=8.68

Requires (Dev)

• orchestra/testbench: ^6.22
• phpunit/phpunit: ^9.0

MIT

• Talles Airan

• laravel-valueserp
• tallesairan

README

Laravel package for the Valueserp API.

Getting Started

Run the following command to install this package into your project.

composer require tallesairan/laravel-valueserp

Optional: publish the config files with the following command:

php artisan vendor:publish --provider="Airan\LaravelValueserp\Providers\LaravelValueserpServiceProvider"

Set the environment variables in your .env file like this:

VALUESERP_API_KEY="YOURAPIKEY"

Prerequisites

You will need Composer to install this package and a valid Valueserp API key.

Installing

After installing this package with Composer, create a new Valueserp instance. And set the your Valueserp API key in your env file.

Something like this:

$client = new LaravelValueserp();

And call the desired endpoint

$client->search()->searchFor('bitcoin');

The current implemented endpoints are:

• GET /search

Documentation for the available parameters can be found here: https://www.valueserp.com/docs/search-api/overview

Running the tests

Copy the phpunit.xml.dist and rename it to phpunit.xml. Set the env variables in the phpunit.xml files.

PLEASE NOTE: running the tests will cost you credits!!!!

• VALUESERP_API_KEY: A valid Valueserp API key

Please see the phpunit.xml.dist for the template.

Run the tests in the Tests directory with PHPUnit.

Built With

• Valueserp - For the API
• PHPUnit - Test Framework
• Laravel - Package Framework
• Laravel Package Boilerplate - For boiler template this package

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please help us to develop this package. Every input and/or feedback is really appreciated! Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email us instead of using the issue tracker.

Credits

• All Contributors

License

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