Pengembangan
RingkasnyaPasang PHP 8.3, Composer, Node.js dengan pnpm, dan MySQL atau SQLite, lalu jalankan composer install, pnpm install, migrasi, dan php artisan test. Kontribusi dikirim lewat pull request dengan pesan commit Conventional Commits.
Daftar isi
Pondok CMS adalah proyek open source berlisensi MIT. Halaman ini untuk developer dan relawan IT yang ingin menjalankan Pondok CMS di komputer sendiri atau berkontribusi.
Apa kebutuhan lingkungan pengembangan? Tautan ke bagian Apa kebutuhan lingkungan pengembangan?
- PHP 8.3 atau lebih baru.
- Composer.
- Node.js dengan pnpm.
- MySQL, atau SQLite untuk pengembangan.
Node.js dan pnpm hanya dibutuhkan di mesin pengembangan dan mesin build. Server produksi tidak membutuhkan Node.
Bagaimana menyiapkan lingkungan lokal? Tautan ke bagian Bagaimana menyiapkan lingkungan lokal?
composer install
pnpm install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed
pnpm run buildUntuk mencoba dengan data lengkap, isi database dengan data demo.
Bagaimana menjalankan test? Tautan ke bagian Bagaimana menjalankan test?
Pondok CMS memakai Pest untuk testing.
php artisan test --compactAnda juga bisa memanggil Pest langsung dan memfilter test tertentu:
vendor/bin/pest --filter=namaTestPondok CMS menargetkan PHP 8.3 di server cPanel, jadi pastikan perubahan Anda tidak memakai fitur PHP yang lebih baru.
Setelah mengubah berkas PHP, rapikan format kode dengan Laravel Pint:
vendor/bin/pint --dirtyKonvensi kode apa yang dipakai? Tautan ke bagian Konvensi kode apa yang dipakai?
| Bagian | Bahasa |
|---|---|
| Teks antarmuka | Indonesia, lewat berkas lang/id |
| Nama tabel, kolom, kelas, dan variabel | Inggris |
Konvensi lain:
- Setiap modul selain inti bisa diaktifkan atau dimatikan.
- Tetap cocok untuk shared hosting: antrean dan cache memakai database, tanpa Redis, tanpa Node saat runtime.
- Data pribadi dilindungi: kolom sensitif dienkripsi, dokumen di disk private, akses lewat permission.
Bagaimana berkontribusi? Tautan ke bagian Bagaimana berkontribusi?
- Fork repositori Pondok CMS di GitHub.
- Buat branch baru dari
main, misalnyafeat/asrama-rekap-kamar. - Tulis perubahan beserta test Pest-nya.
- Pastikan semua test lulus dan kode sudah dirapikan dengan Pint.
- Kirim pull request dengan penjelasan singkat apa yang berubah dan alasannya.
Format pesan commit Tautan ke bagian Format pesan commit
Gunakan Conventional Commits dengan format type(scope): deskripsi. Scope memakai kunci modul, dan satu commit berisi satu perubahan logis.
feat(asrama): tambah rekap penghuni per kamar
fix(keuangan): perbaiki pembulatan cicilan
docs(instalasi): perjelas langkah cronPerbaikan dokumentasi, terjemahan teks antarmuka, dan test tambahan adalah cara yang baik untuk mulai berkontribusi.