README

Laravel package for Wilayah Indonesia administrative data.

This is a laravel version of wilayah indonesia which ONLY provides model, migration, seeder.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require hanzoalpha/laravel-wilayah

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-wilayah-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-wilayah-config"

This is the contents of the published config file:

return [
    'table_prefix' => 'ind_',

    /**
     * API Configuration.
     */
    'api' => [
        /**
         * If enabled, this will load Indonesia API.
         * - http://localhost:8000/api/wilayah/provinces
         * - http://localhost:8000/api/wilayah/cities
         * - http://localhost:8000/api/wilayah/districts
         * - http://localhost:8000/api/wilayah/villages
         */
        'enabled' => true,

        /**
         * The middleware for Indonesia API.
         */
        'middleware' => ['api'],

        /**
         * The route name for Indonesia API.
         */
        'route_name' => 'api.wilayah',

        /**
         * The route prefix for Indonesia API.
         */
        'route_prefix' => 'api/wilayah',

        /**
         * Specify which column will be displayed in the response data.
         * Only support columns from database.
         */
        'response_columns' => [
            //.
            'province' => ['code', 'name'],

            'city' => ['city_code', 'province_code', 'name'],

            'district' => ['district_code', 'city_code', 'name'],

            'village' => ['village_code', 'district_code', 'name'],

            'island' => ['province_code', 'city_code', 'island_code', 'name'],
        ],
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-wilayah-views"

Usage

$laravelWilayah = new HanzoAlpha\LaravelWilayah();
echo $laravelWilayah->echoPhrase('Hello, HanzoAlpha!');

Testing

  ./vendor/bin/pest

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

hanzoalpha / laravel-wilayah

Maintainers

Details