https://github.com/marcreichel/igdb-laravel
Simplify the integration of the IGDB API into your Laravel app. Including IGDB webhook support.
https://github.com/marcreichel/igdb-laravel
api-wrapper apicalypse apicalypse-query hacktoberfest igdb igdb-api igdb-integration igdb-laravel laravel laravel-package laravel-wrapper php query-builder webhooks wrapper
Last synced: 6 months ago
JSON representation
Simplify the integration of the IGDB API into your Laravel app. Including IGDB webhook support.
- Host: GitHub
- URL: https://github.com/marcreichel/igdb-laravel
- Owner: marcreichel
- License: mit
- Created: 2019-01-03T10:20:00.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-30T11:38:38.000Z (6 months ago)
- Last Synced: 2025-04-01T09:32:41.408Z (6 months ago)
- Topics: api-wrapper, apicalypse, apicalypse-query, hacktoberfest, igdb, igdb-api, igdb-integration, igdb-laravel, laravel, laravel-package, laravel-wrapper, php, query-builder, webhooks, wrapper
- Language: PHP
- Homepage: https://marcreichel.dev/docs/igdb-laravel
- Size: 1.26 MB
- Stars: 112
- Watchers: 5
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Laravel IGDB Wrapper
This is a Laravel wrapper for version 4 of the IGDB API (Apicalypse)
including webhook handling.
## Basic installation
You can install this package via composer using:
```bash
composer require marcreichel/igdb-laravel
```
The package will automatically register its service provider.
To publish the config file to `config/igdb.php` run:
```bash
php artisan igdb:publish
```
This is the default content of the config file:
```php
return [
/*
* These are the credentials you got from https://dev.twitch.tv/console/apps
*/
'credentials' => [
'client_id' => env('TWITCH_CLIENT_ID', ''),
'client_secret' => env('TWITCH_CLIENT_SECRET', ''),
],
/*
* This package caches queries automatically (for 1 hour per default).
* Here you can set how long each query should be cached (in seconds).
*
* To turn cache off set this value to 0
*/
'cache_lifetime' => env('IGDB_CACHE_LIFETIME', 3600),
/**
* The prefix used to cache the results.
*
* E.g.: `[CACHE_PREFIX].75170fc230cd88f32e475ff4087f81d9`
*/
'cache_prefix' => 'igdb_cache',
/*
* Path where the webhooks should be handled.
*/
'webhook_path' => 'igdb-webhook/handle',
/*
* The webhook secret.
*
* This needs to be a string of your choice in order to use the webhook
* functionality.
*/
'webhook_secret' => env('IGDB_WEBHOOK_SECRET', null),
];
```
## Documentation
You will find the full documentation on [the dedicated documentation site](https://marcreichel.dev/docs/igdb-laravel).
## Testing
Run the tests with:
```bash
composer test
```
## Contribution
Pull requests are welcome :)