skapelapp/ipstack-laravel

Get information from a visitor's IP address using IPStack and use it in your Laravel project.

v1.0.3 2023-12-08 14:10 UTC

Requires

• php: >=8.0
• laravel/framework: ^10.0

MIT

• Skapel

• geolocation
• laravel
• goip
• ipstack

README

The "skapelapp/ipstack-laravel" package allows you to retrieve visitor information based on their IP address using the IPStack service in your Laravel projects.

• Requirements
• Installation
• Configuration
• Usage
• Testing
• Updates
• License

Requirements

• PHP: ^8.0
• Laravel: ^10.0
• IPStack API Key: (https://ipstack.com/)

Installation

You can add the package to your Laravel project using Composer:

composer require skapelapp/ipstack-laravel

Configuration

1. Set your IPStack API Key in your .env file:

IPSTACK_API_KEY=your-ipstack-api-key

2. Run the following command to publish the configuration:

php artisan vendor:publish --tag=ipstack-laravel-config

This command will create the config/ipstack.php file. You can check and modify your API key in this file.

3. Service Provider and Alias Configuration:

Add the service provider and aliases in your config/app.php file:

'providers' => [
    // ...
    Skapelapp\IpstackLaravel\IpstackLaravelServiceProvider::class,
],

'aliases' => [
    // ...
    'IPStack' => Skapelapp\IpstackLaravel\Facades\IPStack::class,
],

Usage

You can use the IPStack class to interact with the package:

use Skapelapp\IPStackLaravel\IPStack;

// Create an instance of the IPStack class and provide your API key
$apiKey = config('ipstack.api_key');
$ipstack = new IPStack($apiKey);

// Use the getInfo method to retrieve information
$ipInfo = $ipstack->getInfo();

// Make use of the returned information
// dd($ipInfo);

Testing

To run the package tests:

composer test

Updates

To update the package, use the following command:

composer update skapelapp/ipstack-laravel

License

This package is licensed under the MIT License. For detailed information, see the LICENSE file.