Instalasi dan Setup

Badaso dipasang sebagai paket Composer di dalam proyek Laravel. composer.json menandai paket ini bertipe library dan mendaftarkan Uasoft\Badaso\Providers\BadasoServiceProvider pada extra.laravel.providers, sehingga Laravel memuat provider itu otomatis (composer.json:72-78¹). Dependensi runtime yang ikut terpasang mencakup laravel/sanctum, darkaonline/l5-swagger, spatie/laravel-backup, spatie/laravel-activitylog, unisharp/laravel-filemanager, dan laravel/octane (composer.json:26-51²).

Setelah paket terpasang, penyiapan dikerjakan oleh satu perintah, badaso:setup. Perintah itu didaftarkan bersama lima perintah lain di registerConsoleCommands (src/Providers/BadasoServiceProvider.php:118-126³). Sebelum perintah dijalankan, BADASO_LICENSE_KEY harus sudah diisi di .env (CONTRIBUTING.md:41-42⁴), karena config membacanya sebagai badaso.license_key (src/Config/badaso.php:38⁵).

Urutan kerja badaso:setup

Signature perintah adalah badaso:setup {--force=false} dengan deskripsi Setup Badaso (src/Commands/BadasoSetup.php:19-33⁶). Metode handle memanggil 14 langkah secara berurutan, dan setiap langkah berdiri sendiri tanpa pembatalan bila langkah lain gagal (src/Commands/BadasoSetup.php:53-71⁷).

sequenceDiagram
    autonumber
    participant CLI as Artisan CLI
    participant Setup as BadasoSetup
    participant Env as .env
    participant Pkg as package.json
    participant Vite as vite.config.js
    participant Publish as vendor:publish
    participant Auth as config/auth.php
    CLI->>Setup: badaso:setup {--force=false}
    Setup->>Env: addingBadasoEnv
    Setup->>Pkg: updatePackageJson
    Setup->>Vite: updateVite
    Setup->>Publish: publishBadasoProvider tag Badaso
    Setup->>Publish: publishLaravelBackupProvider
    Setup->>Publish: publishLaravelActivityLogProvider tag config
    Setup->>Publish: publishLaravelFileManager tag lfm_public
    Setup->>Publish: publishLaravelAnalytics
    Setup->>Publish: publicFileFirebaseServiceWorker
    Setup->>Auth: addingBadasoAuthConfig
    Setup->>Publish: generateSwagger l5-swagger:generate
    Setup->>Vite: addPluginsLaravelInputVite
    Setup->>Vite: addPluginsVueVite
    Setup->>Vite: addResolveConfigVueVite
%% fig: Siklus satu pemanggilan badaso:setup
%% desc: Perintah badaso:setup menulis .env, package.json, dan vite.config.js, memublikasikan config lewat vendor:publish, lalu mengubah config/auth.php.

Langkah 9 menghapus public/firebase-messaging-sw.js lebih dulu bila berkas itu sudah ada, lalu menulis versi baru (src/Helpers/Firebase/FirebasePublishFile.php:107-116²²).

⚠️ Opsi --force=false memberi nilai default string 'false', sedangkan nilai null muncul ketika opsi diberikan tanpa nilai; keduanya diuji pada satu ekspresi yang menghasilkan $this->force (src/Commands/BadasoSetup.php:55²³). Nilai itu diteruskan ke vendor:publish sebagai --force (src/Commands/BadasoSetup.php:255-265¹¹), sehingga config yang sudah disunting dapat tertimpa.

Kunci .env yang ditambahkan

addingBadasoEnv membaca base_path('.env'), melewati baris komentar dan baris kosong, lalu menambahkan pasangan kunci-nilai yang belum ditemukan (src/Commands/BadasoSetup.php:396-416²⁴). Daftar kunci beserta nilai awalnya berasal dari envListUpload (src/Commands/BadasoSetup.php:334-384²⁵).

Pencocokan kunci memakai strstr($val_env_file, $key_add_env), jadi kunci yang hanya muncul sebagai potongan baris lain juga dianggap sudah ada dan tidak ditulis ulang (src/Commands/BadasoSetup.php:401-405⁴⁰).

Langkah .env di CONTRIBUTING masih memakai prefiks MIX_, misalnya MIX_DEFAULT_MENU dan MIX_ADMIN_PANEL_ROUTE_PREFIX (CONTRIBUTING.md:104-129⁴¹), sedangkan envListUpload menulis kunci VITE_* dan config membacanya kembali lewat env('VITE_ADMIN_PANEL_ROUTE_PREFIX', 'badaso-dashboard') (src/Config/badaso.php:33-35⁴²). Kunci yang berlaku pada kode ini adalah kunci VITE_*.

Konfigurasi Vite

Empat langkah menyentuh vite.config.js. Setiap fungsi dijaga oleh checkExist, yang hanya mengembalikan true bila berkas ada dan belum memuat penanda tertentu (src/Commands/BadasoSetup.php:142-145⁴³).

updateVite menambahkan blok import lewat $this->file->append sehingga import ditulis di akhir berkas (src/Commands/BadasoSetup.php:166-167⁴⁴). Seluruh penyisipan memakai strpos dan substr pada isi berkas, bukan parser JavaScript, sehingga penanda yang hilang membuat langkah dilewati tanpa pesan error (src/Commands/BadasoSetup.php:178-193⁴⁵).

updatePackageJson menambahkan axios, lodash, postcss, sass, dan vite-plugin-static-copy ke devDependencies (src/Commands/BadasoSetup.php:87-91⁴⁶), serta paket frontend seperti vue, vue-router, vuex, vuesax, @vitejs/plugin-vue2, dan vite-plugin-environment ke dependencies (src/Commands/BadasoSetup.php:96-134⁴⁷).

Publikasi config dan aset

boot mendaftarkan empat tag vendor:publish (src/Providers/BadasoServiceProvider.php:51-71⁴⁸).

Migration dan data awal

boot memanggil loadMigrationsFrom(__DIR__.'/../Migrations'), sehingga seluruh migrasi Badaso ikut dijalankan oleh php artisan migrate (src/Providers/BadasoServiceProvider.php:45⁵²). Setiap migrasi memakai prefix dari config('badaso.database.prefix'), misalnya untuk tabel users (src/Migrations/2020_11_12_000000_create_badaso_users_table.php:16⁵³). Prefix itu berasal dari BADASO_TABLE_PREFIX dengan default badaso_ (src/Config/badaso.php:39-41⁵⁴).

Setelah badaso:setup, CONTRIBUTING menjalankan tiga perintah berurutan: composer dump-autoload, php artisan migrate, lalu php artisan db:seed --class=BadasoSeeder (CONTRIBUTING.md:97-102⁵⁵). Kelas BadasoSeeder berada di namespace Database\Seeders\Badaso karena direktori seeder dipublikasikan ke database/seeders/Badaso (src/Seeder/Configurations/BadasoSeeder.php:1-22⁵⁶, src/Providers/BadasoServiceProvider.php:85-89⁵⁰).

run memanggil enam seeder berurutan: RolesSeeder, PermissionsSeeder, RolePermissionsSeeder, MenusSeeder, FixedMenuItemSeeder, dan ConfigurationsSeeder (src/Seeder/Configurations/BadasoSeeder.php:14-22⁵⁷). RolesSeeder mengisi role administrator dan customer (src/Seeder/Configurations/RolesSeeder.php:22-31⁵⁸). ConfigurationsSeeder mengisi group adminPanel dengan kunci seperti adminPanelTitle (src/Seeder/Configurations/ConfigurationsSeeder.php:22-52⁵⁹). Rincian tiap tabel dibahas di Manajemen User, Role, dan Permission dan Menu dan Konfigurasi Aplikasi.

Alur sampai dashboard siap diakses

graph LR
    A["composer install"] --> B["php artisan badaso:setup"]
    B --> C["composer dump-autoload"]
    C --> D["php artisan migrate"]
    D --> E["php artisan db:seed --class=BadasoSeeder"]
    E --> F["php artisan badaso:admin email --create"]
    F --> G["npm install"]
    G --> H["npm run watch atau npm run prod"]
    H --> I["dashboard /{VITE_ADMIN_PANEL_ROUTE_PREFIX}"]
    B --> J["kunci .env dan config di config/"]
    D --> K[("tabel berprefix badaso_")]
    E --> L[("role, permission, menu, configuration")]
    style A fill:#f59e0b,color:#000
    style B fill:#f59e0b,color:#000
    style C fill:#2d7d46,color:#fff
    style D fill:#336791,color:#fff
    style E fill:#336791,color:#fff
    style F fill:#2d7d46,color:#fff
    style G fill:#2d7d46,color:#fff
    style H fill:#2d7d46,color:#fff
    style I fill:#8b5cf6,color:#fff
    style J fill:#f59e0b,color:#000
    style K fill:#336791,color:#fff
    style L fill:#336791,color:#fff
%% fig: Alur setup dari Composer sampai dashboard
%% desc: Perintah berurutan menyiapkan config, tabel, data awal, akun admin, dan aset frontend sebelum dashboard dapat diakses.

Alamat dashboard dibentuk dari VITE_ADMIN_PANEL_ROUTE_PREFIX dengan nilai default badaso-dashboard (src/Config/badaso.php:33-35⁴²). CONTRIBUTING menyebut default dashboard untuk prefiks yang sama (CONTRIBUTING.md:119-121⁶⁰); nilai yang dipakai kode adalah nilai pada src/Config/badaso.php:33-35⁴².

Akun admin pertama

Setelah data awal masuk, akun admin dibuat dengan php artisan badaso:admin [email protected] --create (CONTRIBUTING.md:165-168⁶¹). Perintah badaso:admin menerima opsi create, name, username, password, dan confirm_password (src/Commands/AdminCommand.php:31-40⁶²). Bila password dan konfirmasi berbeda, perintah mencetak Passwords don't match lalu berhenti (src/Commands/AdminCommand.php:136-141). Setelah user disimpan, perintah mengambil atau membuat role administrator lalu menambah satu baris UserRole (src/Commands/AdminCommand.php:145-158). Bila berhasil, perintah mencetak The user now has full access to your site. (src/Commands/AdminCommand.php:65). Wewenang role dibahas di Manajemen User, Role, dan Permission.

Guard autentikasi

addingBadasoAuthConfig menulis ulang config/auth.php dan mengganti providers.users dengan model Uasoft\Badaso\Models\User (src/Commands/BadasoSetup.php:317-327⁶⁶). Bila langkah ini gagal, perintah mencetak Failed adding badaso auth config lalu melanjutkan langkah berikutnya (src/Commands/BadasoSetup.php:329-331⁶⁷). Config bawaan memakai guard sanctum (src/Config/badaso.php:10-12⁶⁸), sedangkan CONTRIBUTING.md masih mendokumentasikan guard badaso_guard dengan driver jwt (CONTRIBUTING.md:134-162⁶⁹). Mekanisme autentikasi dijelaskan di Autentikasi dan Otorisasi.

Setup pengujian

Perintah badaso-test:setup menulis berkas phpunit.xml di base_path() (src/Commands/BadasoTestSetup.php:15-22⁷⁰). Isi XML memuat dua testsuite, Unit dan Feature, yang masing-masing menjalankan direktori ./tests/... dan ./vendor/badaso/core/tests/...; blok coverage yang mengarah ke direktori ./vendor/badaso/core/src/...; serta <server> seperti APP_ENV=testing dan CACHE_DRIVER=array (src/Commands/BadasoTestSetup.php:43-89⁷¹). Berkas ditulis lewat file_put_contents tanpa memeriksa berkas lama (src/Commands/BadasoTestSetup.php:91⁷²).

⚠️ badaso-test:setup menimpa phpunit.xml yang sudah ada tanpa konfirmasi (src/Commands/BadasoTestSetup.php:91⁷²). Alur CI yang memakai berkas ini dibahas di Pengujian dan CI.