ideal-postcodes-laravel
, (*1)
, (*2)
PHP Laravel 5 package for the Ideal Postcodes API., (*3)
Prerequisites
- PHP 5.5+
- Laravel 5.x
- Ideal Postcodes Account and API Key
Installation
Install by composer
You can find this library on Packagist., (*4)
To install ideal-postcodes-laravel with Composer, run the following command:, (*5)
$ composer require squigg/ideal-postcodes-laravel
Configuration
The package publishes a configuration file to your config directory where you can update the configuration for your app., (*6)
$ php artisan vendor:publish --tag=config
Add the IdealPostcodesServiceProvider and (if desired) the Facade alias to your app.php:, (*7)
'providers' => [
...
'Squigg\IdealPostcodes\IdealPostcodesServiceProvider',
],
'aliases' => [
...
'IdealPostcodes' => 'Squigg\IdealPostcodes\Facades\IdealPostcodesFacade',
],
Add an IDEALPOSTCODES_API_KEY to your .env file with your Ideal Postcodes API key, (*8)
IDEALPOSTCODES_API_KEY=ak_abcdefghijklmnopqrstuvwxyz
Configuration File Settings
All available settings are documented within the config/ideal-postcodes.php configuration file., (*9)
Usage
Simply call the \IdealPostcodes Facade, or add a dependency in any constructor to IdealPostcodes, (*10)
Change log
See changelog, (*11)
Copyright © 2016 Steve Strugnell. Released under the MIT License <docs/license.rst>_., (*12)
Wallogit.com
squigg