Skip to content

roedyrustam/API-Wilayah-2024

Repository files navigation

API Wilayah Indonesia 2024

API Wilayah Indonesia 2024 adalah project open source laravel Filament Tall 3 untuk akses data Provinsi, Kabupaten, Kecamatan dan Kelurahan di Indonesia.

Requirement

  • PHP 8.1
  • MYSQL (untuk Database)
  • Composer 2.6.5^
  • Internet, karena menggunakan composer dan untuk mengunduh dependency yang diperlukan saat install
  • Git (Optional) Untuk clone project
  • Code Editor (Optional) Untuk edit konfigurasi .env (bisa pakai notepad, notepad++, vscode, sublime, atau nano, vim dll)

Installation

  • Untuk mejalankan project ini di lokal, ikuti langkah berikut:

  • Clone project ini dengan cara download atau dengan command :

git clone https://github.com/roedyrustam/
  • Masuk ke folder project dan Install dependency dengan composer
cd API-Wilayah-Indonesia-2024
composer install
  • Buat File .env dan generate key
cp .env.example .env
php artisan key:generate
  • Buka vscode atau kode editor lain untuk ubah konfigurasi db di file .env

Migrasi Data dan Seeding Data'

Secara default, master data Provinsi, Kabupaten, Kecamatan dan Kelurahan ada di folder public/json dengan format json.

  • Untuk migrasi jalankan command :
php artisan migrate
  • Untuk seeding data jalankan command :
php artisan db:seed --class=FromJsonSeeder

Run Project Laravel Filament 3 Api Wilayah Indonesi 2024

  • Jalankan command :
php artisan serve

Dokumentasi API

Master dari file dokumentasi yaml ada di folder public/docs. Untuk membuka dokumentasi API, buka http://127.0.0.1:8000/api/documentation

Roadmap

  • Include dasboard to manage data
  • Update data terbaru
  • Include kode pos
  • Include latitude and longitude