docs: update README.md
This commit is contained in:
@@ -11,9 +11,10 @@ Sistem web production-ready untuk **Organisasi Pemuda Desa Persegi**, berlokasi
|
||||
| Backend | Laravel 13 |
|
||||
| Admin Panel | Filament 5.x |
|
||||
| Authorization | Filament Shield + Spatie Permission |
|
||||
| Database | MySQL |
|
||||
| Frontend Publik | Blade |
|
||||
| Database | MySQL / MariaDB |
|
||||
| Frontend Publik | Blade + Tailwind CSS |
|
||||
| Realtime | Livewire |
|
||||
| Queue | Supervisor |
|
||||
|
||||
---
|
||||
|
||||
@@ -22,7 +23,7 @@ Sistem web production-ready untuk **Organisasi Pemuda Desa Persegi**, berlokasi
|
||||
```
|
||||
app/
|
||||
├── Filament/
|
||||
│ ├── Resources/ # Admin panel resources
|
||||
│ ├── Resources/
|
||||
│ │ ├── Activities/ # Manajemen kegiatan
|
||||
│ │ ├── Approvals/ # Multi-approval
|
||||
│ │ ├── Audits/ # Audit internal
|
||||
@@ -35,28 +36,21 @@ app/
|
||||
│ │ └── Votes/ # Sistem voting
|
||||
│ └── Widgets/
|
||||
│ ├── StatsOverview.php # Widget dashboard utama
|
||||
│ ├── CashStatsWidget.php # Widget statistik kas (halaman transaksi)
|
||||
│ ├── CashStatsWidget.php # Widget statistik kas
|
||||
│ └── ActivityLogWidget.php # Widget log aktivitas
|
||||
├── Models/
|
||||
│ ├── User.php # Anggota / pengguna sistem
|
||||
│ ├── Division.php # Divisi organisasi
|
||||
│ ├── Activity.php # Kegiatan
|
||||
│ ├── CashRecord.php # Transaksi kas
|
||||
│ ├── CashCategory.php # Kategori kas (pemasukan/pengeluaran)
|
||||
│ ├── Vote.php # Voting
|
||||
│ ├── VoteItem.php # Pilihan suara per user
|
||||
│ ├── Approval.php # Multi-approval
|
||||
│ ├── ApprovalItem.php # Keputusan per approver
|
||||
│ ├── Audit.php # Temuan audit
|
||||
│ ├── AuditResponse.php # Respons atas temuan audit
|
||||
│ ├── MemberStatusLog.php # Riwayat perubahan status anggota
|
||||
│ ├── ActivityLog.php # Log global semua aksi
|
||||
│ ├── Post.php # Artikel/berita publik
|
||||
│ └── ContactMessage.php # Pesan kontak dari publik
|
||||
│ ├── User.php, Division.php, Activity.php
|
||||
│ ├── CashRecord.php, CashCategory.php
|
||||
│ ├── Vote.php, VoteItem.php
|
||||
│ ├── Approval.php, ApprovalItem.php
|
||||
│ ├── Audit.php, AuditResponse.php
|
||||
│ ├── MemberStatusLog.php, ActivityLog.php
|
||||
│ ├── Post.php, ContactMessage.php
|
||||
└── Observers/
|
||||
├── CashRecordObserver.php
|
||||
├── ActivityObserver.php
|
||||
└── UserObserver.php
|
||||
├── CashRecordObserver.php # Log + threshold approval/voting
|
||||
├── ActivityObserver.php # Log approval & eksekusi kegiatan
|
||||
├── UserObserver.php # Log perubahan status anggota
|
||||
└── VoteObserver.php # Notifikasi voting baru ke semua user
|
||||
```
|
||||
|
||||
---
|
||||
@@ -65,171 +59,66 @@ app/
|
||||
|
||||
| Role | Deskripsi |
|
||||
|---|---|
|
||||
| `super_admin` | Full akses, bisa override semua, semua aksi di-log |
|
||||
| `super_admin` | Full akses, override semua, semua aksi di-log |
|
||||
| `ketua` | Approval kegiatan, verifikasi kas, lihat semua data |
|
||||
| `bendahara` | Input & kelola transaksi kas |
|
||||
| `pengurus` | Submit kegiatan ke pending |
|
||||
| `anggota` | Akses terbatas, lihat data sendiri |
|
||||
| `anggota` | Akses terbatas, bisa voting |
|
||||
| `auditor` | Read-only + bisa buat temuan audit |
|
||||
|
||||
---
|
||||
|
||||
## Fitur & Use Case
|
||||
## Fitur
|
||||
|
||||
### 1. Manajemen Anggota
|
||||
### Keuangan (Kas)
|
||||
|
||||
**Aktor:** ketua, pengurus, super_admin
|
||||
Threshold otomatis saat transaksi dibuat:
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
| Jumlah | Alur |
|
||||
|---|---|
|
||||
| Tambah anggota | Input data: nama, telepon, alamat, divisi, status |
|
||||
| Ubah status anggota | Aktif → Nonaktif wajib isi `inactive_reason` |
|
||||
| Lihat riwayat status | Semua perubahan status tercatat di `member_status_logs` |
|
||||
| Filter per divisi | Anggota bisa difilter berdasarkan divisi |
|
||||
| < Rp 500.000 | Langsung bisa diverifikasi |
|
||||
| Rp 500.000 – Rp 2.000.000 | Notifikasi ke ketua → perlu approval ketua |
|
||||
| > Rp 2.000.000 | Voting dibuat otomatis → perlu mayoritas >50% |
|
||||
|
||||
**Business rule:**
|
||||
- Hanya ketua, pengurus, super_admin yang bisa ubah status
|
||||
- Setiap perubahan status otomatis dicatat ke `member_status_logs` via Observer
|
||||
- Transaksi yang belum diverifikasi tidak masuk ke total kas
|
||||
- Setelah `verified_at` terisi, data terkunci (tidak bisa diubah/dihapus)
|
||||
- Widget statistik kas tampil di halaman transaksi: total saldo, pemasukan/pengeluaran bulan ini, saldo bulan lalu
|
||||
|
||||
---
|
||||
### Kegiatan
|
||||
|
||||
### 2. Struktur Organisasi (Divisi)
|
||||
|
||||
**Aktor:** ketua, super_admin
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Kelola divisi | CRUD divisi organisasi |
|
||||
| Lihat anggota per divisi | Relasi one-to-many ke User |
|
||||
|
||||
---
|
||||
|
||||
### 3. Kegiatan
|
||||
|
||||
**Aktor:** pengurus (buat), ketua (approve), semua (lihat)
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Buat kegiatan | Status awal: `draft` |
|
||||
| Submit ke review | `draft` → `pending` (oleh pengurus) |
|
||||
| Approve/Tolak | `pending` → `approved` / `rejected` (oleh ketua) |
|
||||
| Tandai selesai | Wajib isi `executed_at` + `execution_notes` |
|
||||
| Kelola peserta | Many-to-many anggota ↔ kegiatan |
|
||||
|
||||
**Workflow status:**
|
||||
```
|
||||
draft → pending → approved → (executed_at diisi)
|
||||
→ rejected
|
||||
```
|
||||
|
||||
---
|
||||
### Voting
|
||||
|
||||
### 4. Keuangan (Kas)
|
||||
- Semua user bisa melihat dan memberi suara
|
||||
- Tipe: `activity`, `finance`, `general`
|
||||
- Notifikasi ke semua user saat voting baru dibuat
|
||||
- Mayoritas >50% untuk lolos
|
||||
|
||||
**Aktor:** bendahara (input), ketua & super_admin (verifikasi & lihat)
|
||||
### Notifikasi
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Input transaksi | Bendahara input pemasukan/pengeluaran |
|
||||
| Verifikasi transaksi | Ketua/super_admin verifikasi, setelah itu data terkunci |
|
||||
| Lihat statistik kas | Widget di halaman transaksi: total saldo, pemasukan/pengeluaran bulan ini, saldo bulan lalu |
|
||||
| Filter transaksi | Filter per kategori, tanggal, status verifikasi |
|
||||
- Database notifications via Filament
|
||||
- Polling otomatis setiap 30 detik
|
||||
- Queue diproses via Supervisor
|
||||
|
||||
**Business rule:**
|
||||
- Setelah `verified_at` terisi, data tidak bisa diubah/dihapus
|
||||
- Threshold keuangan:
|
||||
- < Rp 500.000 → bendahara saja
|
||||
- Rp 500.000 – Rp 2.000.000 → butuh persetujuan ketua
|
||||
- > Rp 2.000.000 → multi-approval atau voting
|
||||
### Konten Publik
|
||||
|
||||
---
|
||||
|
||||
### 5. Voting
|
||||
|
||||
**Aktor:** semua role (sesuai permission)
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Buat voting | Tipe: `activity`, `finance`, `general` |
|
||||
| Beri suara | Pilihan: `approve`, `reject`, `abstain` |
|
||||
| Tutup voting | Status: `open` → `closed` |
|
||||
| Lihat hasil | Mayoritas >50% untuk lolos |
|
||||
|
||||
---
|
||||
|
||||
### 6. Multi-Approval
|
||||
|
||||
**Aktor:** role yang ditentukan per approval
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Buat approval | Tentukan jumlah approval yang dibutuhkan |
|
||||
| Beri keputusan | Tiap approver bisa approve/reject + catatan |
|
||||
| Cek status | Lolos jika jumlah approve terpenuhi |
|
||||
|
||||
---
|
||||
|
||||
### 7. Audit Internal
|
||||
|
||||
**Aktor:** auditor (buat temuan), pengurus/ketua (respons)
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Buat temuan | Tipe: `warning` / `critical`, bisa terkait model apapun |
|
||||
| Respons temuan | Pihak terkait bisa balas temuan audit |
|
||||
| Pantau status | Auditor bisa track status penyelesaian |
|
||||
|
||||
---
|
||||
|
||||
### 8. Konten Publik
|
||||
|
||||
**Aktor:** pengurus, ketua, super_admin
|
||||
|
||||
| Use Case | Deskripsi |
|
||||
|---|---|
|
||||
| Buat artikel/berita | Post dengan status `draft` / `published` |
|
||||
| Website publik | Halaman publik berbasis Blade untuk masyarakat |
|
||||
| Pesan kontak | Masyarakat bisa kirim pesan, admin bisa lihat & balas |
|
||||
|
||||
---
|
||||
|
||||
### 9. Dashboard
|
||||
|
||||
Widget yang tampil di halaman utama admin:
|
||||
|
||||
| Widget | Isi |
|
||||
|---|---|
|
||||
| StatsOverview | Anggota aktif, total kas, kegiatan berjalan, kegiatan pending |
|
||||
| ActivityLogWidget | Log aktivitas terbaru di sistem |
|
||||
|
||||
Widget khusus halaman transaksi:
|
||||
|
||||
| Widget | Isi |
|
||||
|---|---|
|
||||
| CashStatsWidget | Total saldo, pemasukan bulan ini, pengeluaran bulan ini, saldo bulan lalu |
|
||||
- Website publik berbasis Blade (font: Roboto + Playfair Display)
|
||||
- Artikel/berita, halaman kegiatan, form kontak
|
||||
- Link ke website publik tersedia di sidebar admin
|
||||
|
||||
---
|
||||
|
||||
## Log & Audit Trail
|
||||
|
||||
Semua aksi penting otomatis dicatat via Observer:
|
||||
|
||||
| Event | Dicatat di |
|
||||
|---|---|
|
||||
| Perubahan status anggota | `member_status_logs` |
|
||||
| Transaksi kas baru | `activity_logs` |
|
||||
| Verifikasi kas | `activity_logs` |
|
||||
| Approval kegiatan | `activity_logs` |
|
||||
| Eksekusi kegiatan | `activity_logs` |
|
||||
|
||||
---
|
||||
|
||||
## Keamanan
|
||||
|
||||
- Setiap resource dilindungi Laravel Policy
|
||||
- Permission granular dikelola via Filament Shield
|
||||
- Fitur impersonate: super_admin bisa login sebagai user lain (untuk debugging/support)
|
||||
- Input divalidasi di semua form
|
||||
| Transaksi kas baru/verifikasi | `activity_logs` |
|
||||
| Approval/eksekusi kegiatan | `activity_logs` |
|
||||
|
||||
---
|
||||
|
||||
@@ -240,8 +129,35 @@ composer install
|
||||
cp .env.example .env
|
||||
php artisan key:generate
|
||||
php artisan migrate --seed
|
||||
php artisan shield:generate --all
|
||||
php artisan shield:generate --panel=admin
|
||||
php artisan shield:super-admin --user=1
|
||||
```
|
||||
|
||||
Akses admin panel: `/dashboard`
|
||||
|
||||
### Queue Worker (Supervisor)
|
||||
|
||||
```ini
|
||||
[program:persegi-worker]
|
||||
command=php /path/to/project/artisan queue:work --sleep=3 --tries=3
|
||||
autostart=true
|
||||
autorestart=true
|
||||
user=$USER
|
||||
redirect_stderr=true
|
||||
stdout_logfile=/var/log/persegi-worker.log
|
||||
```
|
||||
|
||||
```bash
|
||||
sudo supervisorctl reread
|
||||
sudo supervisorctl update
|
||||
sudo supervisorctl start persegi-worker
|
||||
```
|
||||
|
||||
### Production
|
||||
|
||||
```bash
|
||||
php artisan config:cache
|
||||
php artisan route:cache
|
||||
php artisan view:cache
|
||||
php artisan permission:cache-reset
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user