vicky-project/coreui-module

1.0.104 2026-05-01 17:27 UTC

Requires

• php: ^8.0
• joshbrw/laravel-module-installer: ^1.0
• nwidart/laravel-modules: ^12.0
• predis/predis: ^3.2

MIT

• Vicky Rahman

README

Persyaratan Sebelum Memulai

• Proyek Laravel harus sudah ada. Jika belum, silakan buat terlebih dahulu mengikuti dokumentasi resmi Laravel.
• PHP versi 8.2 atau lebih baru.
• Composer terinstal di komputer Anda.

Langkah-Langkah Instalasi

1. Pastikan Proyek Laravel Sudah Siap

Jika sudah memiliki proyek Laravel, lanjut ke langkah 2. Jika belum, buat proyek baru dengan perintah:

composer create-project laravel/laravel nama-proyek-anda
cd nama-proyek-anda

1. Instal Module Menggunakan Composer

Jalankan perintah berikut di dalam folder root proyek Laravel Anda:

composer require vicky-project/coreui-module

Perintah ini akan mengunduh dan memasang module beserta semua dependensi yang diperlukan.

1. Tambahkan Konfigurasi ke File composer.json

Buka file composer.json yang berada di root folder proyek Anda. Anda perlu menambahkan beberapa baris konfigurasi di dalam bagian "extra", "config", dan "autoload".

🔧 Bagian "extra"

Cari kunci "extra" di dalam file composer.json. Jika belum ada, buat. Tambahkan kode berikut:

"extra": {
    "laravel": {
        "dont-discover": []
    },
    "merge-plugin": {
        "include": [
            "Modules/*/composer.json"
        ],
        "recurse": true,
        "replace": false,
        "merge-dev": true,
        "merge-extra": true
    },
    "module-dir": "Modules"
},

Warning

Perhatikan tanda koma (,) pada file composer.json.
Setiap penambahan konfigurasi harus memperhatikan posisi koma agar tidak merusak format JSON. Kesalahan koma akan mengakibatkan error saat menjalankan composer atau php artisan.

⚙️ Bagian "config"

Cari kunci "config". Tambahkan atau sesuaikan sehingga berisi:

"config": {
    "optimize-autoloader": true,
    "preferred-install": "dist",
    "sort-packages": true,
    "allow-plugins": {
        "joshbrw/laravel-module-installer": true,
        "pestphp/pest-plugin": true,
        "php-http/discovery": true,
        "wikimedia/composer-merge-plugin": true
    }
},

📁 Bagian "autoload"

Cari kunci "autoload". Di dalam bagian "psr-4", tambahkan baris berikut (jika sudah ada baris lain, letakkan setelah baris terakhir dan beri koma):

"autoload": {
    "psr-4": {
        // ... baris yang sudah ada (misal: "App\\": "app/",)
        "Modules\\": "Modules/"
    }
},

💡 Contoh lengkap setelah ditambahkan:

"Modules\\": "Modules/"

Note

Module ini menggunakan library nwidart/laravel-modules.
Lihat dokumentasi resmi untuk informasi lebih lanjut.

1. Perbarui Autoloader Composer

Setelah mengedit composer.json, jalankan perintah:

composer dump-autoload

1. Jalankan Migrasi Database

Module ini membutuhkan tabel-tabel database. Jalankan perintah berikut:

php artisan migrate

Jika ada pertanyaan tentang database yang belum disiapkan, pastikan Anda sudah mengatur koneksi database di file .env.

🛠️ Perintah Tambahan yang Tersedia

Setelah module terinstal, Anda bisa menggunakan perintah artisan berikut:

Instal Module Tertentu

php artisan app:install [nama_module]

Ganti [nama_module] dengan nama module yang ingin diinstal (contoh: coreui).

Lihat Daftar Semua Perintah dari Module

php artisan app help

Perintah ini akan menampilkan semua perintah artisan yang tersedia di dalam namespace app, termasuk yang disediakan oleh module.

Verifikasi Instalasi

Untuk memastikan semuanya berjalan lancar:

1. Coba jalankan php artisan app help – Anda akan melihat daftar perintah.
2. Coba akses aplikasi Laravel Anda melalui browser. Jika module menambahkan rute atau tampilan, seharusnya sudah tersedia.

Tips & Pemecahan Masalah

Masalah	Solusi
Class "Modules\... not found	Pastikan Anda sudah menjalankan composer dump-autoload setelah mengedit composer.json.
Composer merge-plugin error	Pastikan plugin wikimedia/composer-merge-plugin sudah diizinkan di bagian allow-plugins.
Migrasi gagal	Periksa koneksi database di file .env. Jalankan php artisan migrate:fresh jika ingin memulai ulang.
Perintah app:install tidak dikenal	Cek apakah module sudah terinstal dengan benar. Jalankan composer require sekali lagi jika perlu.