https://github.com/yajra/laravel-address
Philippines Regions, Provinces, Cities and Barangays Address Lookup API for Laravel.
https://github.com/yajra/laravel-address
address api hacktoberfest laravel lookup php
Last synced: 7 months ago
JSON representation
Philippines Regions, Provinces, Cities and Barangays Address Lookup API for Laravel.
- Host: GitHub
- URL: https://github.com/yajra/laravel-address
- Owner: yajra
- License: mit
- Created: 2018-06-07T10:57:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T14:00:29.000Z (over 1 year ago)
- Last Synced: 2024-05-02T00:55:02.112Z (over 1 year ago)
- Topics: address, api, hacktoberfest, laravel, lookup, php
- Language: PHP
- Homepage:
- Size: 4.62 MB
- Stars: 30
- Watchers: 4
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Philippines Address Lookup for Laravel
[![Latest Version on Packagist][ico-version]][link-packagist]
[](https://github.com/yajra/laravel-address/actions/workflows/continuous-integration.yml)
[](https://github.com/yajra/laravel-address/actions/workflows/static-analysis.yml)
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![Software License][ico-license]](LICENSE.md)
A package for providing Philippines Address lookup API with Laravel.
## Installation
``` bash
composer require yajra/laravel-address
```
### Register service provider (Optional on Laravel 5.5+)
```php
Yajra\Address\AddressServiceProvider::class
```
### Publish config (Optional)
```bash
php artisan vendor:publish
```
## Available Config
`address.prefix` To change the API base route.
`address.middleware` Route middleware.
## Required Setup (Migration and Seeder)
- Run the address migration.
```bash
php artisan migrate
```
- Run the address seeder.
```bash
php artisan db:seed Yajra\\Address\\Seeders\\AddressSeeder
````
## Routes
The default prefix for the api routes is `/api/address`. The default can be updated via config `address.php` file.
- Get All Regions `/api/address/regions`.
- Get All Provinces `/api/address/provinces`.
- Get Provinces By Region `/api/address/provinces/{regionId}`.
- Get Cities By Province `/api/address/cities/{provinceId}`.
- Get Barangays By City `/api/address/barangays/{cityId}`.
## Usage / Examples
### Add address migration
Add address migration using `$table->address()`. This will add the following fields:
- street
- barangay_id
- city_id
- province_id
- region_id
### Include built-in form (Requires jQuery)
On your view, include `@include('address::form', ['model' => $modelWithAddress])`
### Add scripts section on your master layout.
Before the end of body tag, include `@stack('scripts')`.
```php
-- Contents Here ---
@stack('scripts')
```
## Model with Address Integration
Just use `Yajra\Address\HasAddress` trait on your model to load address models relationship.
```php
use Yajra\Address\HasAddress;
class User extends Model {
use HasAddress;
}
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
## Security
If you discover any security related issues, please email aqangeles@gmail.com instead of using the issue tracker.
## Credits
- [Arjay Angeles][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/yajra/laravel-address.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/yajra/laravel-address/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/yajra/laravel-address.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/yajra/laravel-address.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/yajra/laravel-address.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/yajra/laravel-address
[link-travis]: https://travis-ci.org/yajra/laravel-address
[link-scrutinizer]: https://scrutinizer-ci.com/g/yajra/laravel-address/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/yajra/laravel-address
[link-downloads]: https://packagist.org/packages/yajra/laravel-address
[link-author]: https://github.com/yajra
[link-contributors]: ../../contributors