Coder Social home page Coder Social logo

phamphuchinh1606 / laravel-address Goto Github PK

View Code? Open in Web Editor NEW

This project forked from yajra/laravel-address

0.0 1.0 0.0 548 KB

Philippines Regions, Provinces, Cities and Barangays Address Lookup API for Laravel.

License: MIT License

PHP 90.68% HTML 9.32%

laravel-address's Introduction

Philippines Address Lookup for Laravel (WIP)

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

A package for providing Philippines Address lookup API with Laravel.

Install

  • Via Composer
$ composer require yajra/laravel-address

Providers and Config

If you are using Laravel 5.5+ then the steps below are optional.

  • Register service provider
Yajra\Address\AddressServiceProvider::class
  • Publish config
$ 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. php artisan migrate
  • Run the address seeder. php artisan db:seed --class=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/provices/{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 you view, include @include('address::form', ['model' => $modelWithAddress])

Add scripts section on your master layout.

Before the end of body tag, include @stack('scripts').

<body>
-- Contents Here ---

<script src="/vendor/jquery.js"></script>
@stack('scripts')
</body>

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

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

Credits

Buy me a coffee

paypal Become a Patron

License

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

laravel-address's People

Contributors

yajra avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.