creasi/laravel-nusa

A Laravel package that aim to provide Indonesia' Administrative Data

v0.1.14 2025-07-09 04:47 UTC

README

Version License Actions Status Total Downloads

Laravel Nusa provides complete, ready-to-use Indonesian administrative region data for Laravel applications. This package includes all 38 provinces, 514 regencies, 7,285 districts, and 83,762 villages with their hierarchical relationships, postal codes, and geographic coordinates.

Laravel Nusa solves the common challenge of integrating Indonesian administrative data into Laravel applications. Unlike other packages, it requires no data migration or seeding—the data is ready immediately after installation.

What's Included

Instead of manually importing and maintaining large datasets, you get:

  • Instant Setup: Pre-packaged SQLite database with all data ready to use
  • Official Data: Sourced from authoritative Indonesian government databases
  • Complete Models: Province, Regency, District, Village with relationships
  • RESTful API: Ready-to-use endpoints for all administrative levels
  • Address Management: Built-in address system with validation
  • Geographic Data: Coordinates and postal codes
  • Customizable: Extend models and customize to fit your needs

Documentation

For complete usage instructions, API reference, examples, and guides, visit our comprehensive documentation:

📚 Laravel Nusa Documentation

Quick Start

Install the package via Composer:

composer require creasi/laravel-nusa

Start using it immediately:

use Creasi\Nusa\Models\Province;

// Get all provinces
$provinces = Province::all();

// Search by name or code
$jateng = Province::search('Jawa Tengah')->first();
$jateng = Province::search('33')->first();

// Get related data
$regencies = $jateng->regencies;
$districts = $jateng->districts;
$villages = $jateng->villages;

That's all! The package is ready to use immediately after installation.

Contributing

For development setup, contribution guidelines, and detailed information about the project structure, see the full documentation.

Credits

License

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