# Dokumentasi Teknis & Operasional KeluargaMart Selamat datang di pusat dokumentasi resmi **KeluargaMart Monorepo**. Seluruh spesifikasi arsitektur, panduan developer, tata kelola agen AI, dan runbook operasional produksi dikelompokkan di bawah ini. --- ## πŸ“‘ Peta Navigasi Dokumentasi ### Catatan Rilis & Riwayat Commit - [**Master System Reference, Operational Guidelines & Audit Ledger (MD)**](./MASTER_SYSTEM_REFERENCE_AND_GUIDELINES.md): Panduan utama, audit kesehatan sistem, milestone, log perbaikan riil, dan runbook operasional. - [**Changelog platform β€” versi 1.4.1 (30 Oktober 2026)**](../CHANGELOG.md): Ringkasan rilis bersama ERP, POS, dan B2B serta arsip versi sebelumnya. - [**Catatan pengguna versi 1.4.1 (TXT)**](../CHANGELOG-v1.4.1.txt): DO stepper sync & guard, auto-settle COD on delivery, fix return 403, bulletproof PWA Service Worker & modern mobile meta tag. - [**Catatan pengguna versi 1.4.0 (TXT)**](../CHANGELOG-v1.4.0.txt): Background push notification PWA, otorisasi transfer stok, retur B2B, pemisahan aksi gudang, COD tunai, dan fail-open rate limiter. - [**Catatan pengguna versi 1.3.0 (TXT)**](../CHANGELOG-v1.3.0.txt): Packing Order B2B, retur e-commerce, reset nomor bulanan, COD cash B2B, dan naskah video omnichannel. - [**Catatan pengguna versi 1.2.0 (TXT)**](../CHANGELOG-v1.2.0.txt): Perbaikan kas shift, stok, checkout B2B, transfer fisik, dan tiket bantuan dalam bahasa Indonesia. - [**Ledger seluruh commit & atribusi versi (TXT)**](../CHANGELOG-COMMITS.txt): 1149 commit reachable, termasuk merge, revert, dan riwayat rilis SemVer monorepo. - [**Panduan Alur Video Presentasi (MD)**](./PANDUAN_ALUR_VIDEO_PRESENTASI.md): Storyboard teknis, rekomendasi urutan demo, dan verifikasi data ERP. - [**Naskah & Skrip Video Presentasi Lengkap (MD)**](./SKRIP_VIDEO_PRESENTASI_LENGKAP.md): Naskah voiceover kata-demi-kata siap rekam untuk 3 modul platform. - [**Rincian integritas transaksi versi 1.2.0 (TXT)**](../CATATAN-PERBAIKAN-INTEGRITAS-TRANSAKSI.txt): Alur transaksi, migrasi database, dan batas bukti pengujian lokal; bukan konfirmasi deployment produksi. - [**Arsip catatan pengguna versi 1.1.0 (TXT)**](./CHANGELOG-v1.1.0.txt): Catatan rilis sebelumnya tetap dipertahankan. ### 1. Instruksi AI Coding & Standar Kerja (Agent Instructions) - πŸ€– [**`AGENTS.md` (Root Canonical)**](../AGENTS.md): Aturan utama agen AI, batasan arsitektur, dan prinsip anti-drift. - πŸ”— [**`AGENT.md` (Compatibility Pointer)**](../AGENT.md): Pointer kompatibilitas alat bantu AI. - πŸ“ **Instruksi Khusus Aplikasi**: - [`apps/backend/AGENTS.md`](../apps/backend/AGENTS.md): Panduan Go Chi, database pool, transactions, dan otorisasi. - [`apps/erp/AGENTS.md`](../apps/erp/AGENTS.md): Panduan Vue 3, PrimeVue, Pinia, dan Nginx serving. - [`apps/pos/AGENTS.md`](../apps/pos/AGENTS.md): Panduan kasir POS, barcode scanning, shift, dan idempotency. - [`apps/b2b/AGENTS.md`](../apps/b2b/AGENTS.md): Panduan Nuxt 4 SSR, memory constraint, dan proxying. - [`apps/nextreport/AGENTS.md`](../apps/nextreport/AGENTS.md): Panduan Chromium/Puppeteer reporting microservice. - πŸ“¦ **Instruksi Khusus Package**: - [`packages/contracts/AGENTS.md`](../packages/contracts/AGENTS.md): Registri rute kanonikal & drift guard. - [`packages/permissions/AGENTS.md`](../packages/permissions/AGENTS.md): 198 permissions & otorisasi RBAC. - [`packages/utils/AGENTS.md`](../packages/utils/AGENTS.md): Formatting uang Rupiah, tanggal, dan idempotency token. - [`packages/api-client/AGENTS.md`](../packages/api-client/AGENTS.md): Wrapper Axios & ApiError normalization. - [`packages/ui/AGENTS.md`](../packages/ui/AGENTS.md): Aturan target shared UI design tokens. --- ### 2. Arsitektur Sistem (Architecture) - πŸ“ [**Arsitektur Sistem (Overview)**](./architecture/overview.md): Visi arsitektur, model single source of truth, dan peran masing-masing client. - πŸ”— [**Batasan Komponen & Dependency Graph**](./architecture/boundaries-and-dependencies.md): Aturan import, matriks dependensi antar-package, dan diagram komponen. - πŸ“œ [**Tata Kelola Kontrak API & Permissions**](./architecture/contracts-and-governance.md): Mekanisme drift guard otomatis (`scripts/check-drift.py`). - πŸ›οΈ [**Architecture Decision Records (ADR)**](./adr/): - [ADR 0001: Migrasi ke Monorepo pnpm & Turborepo](./adr/0001-monorepo-pnpm-turborepo.md) - [ADR 0002: Ekstraksi Shared Packages](./adr/0002-shared-packages-extraction.md) - [ADR 0003: Tata Kelola Toolchain Polyglot](./adr/0003-polyglot-toolchain-governance.md) --- ### 2b. Alur Operasional (untuk pengguna bisnis) - [**Alur Pesanan: dari order sampai uang tercatat**](./operations/order-to-cash.md): siapa menyetujui di mana, kapan invoice terbit, di mana pembayaran diverifikasi, dan bagaimana pesanan ambil-di-toko berbeda dari kirim-ke-alamat. ### 3. Panduan Pengembang & Tim (Development) - πŸš€ [**Panduan Memulai (Getting Started)**](./development/getting-started.md): Setup lokal workstation, instalasi, dan menjalankan server dev. - ⚑ [**Panduan Turborepo**](./development/turborepo-guide.md): Orkestrasi pipeline, filtering, dan strategi cache. - πŸ”„ [**Alur Kerja Penambahan API**](./development/api-workflow.md): Langkah penambahan endpoint baru dari Go ke OpenAPI dan Frontend. - 🌐 [**Matriks Environment Variables**](./development/environment-matrix.md): Daftar lengkap variabel lingkungan seluruh aplikasi. - πŸ‘₯ [**Alur Kerja Tim (Team Workflow)**](./development/team-workflow.md): Matriks kepemilikan workstream dan task lifecycle. - πŸ€– [**Alur Kerja Agen AI (Agent Workflow)**](./development/agent-workflow.md): Protokol vibe coding aman tanpa halusinasi. - πŸ§ͺ [**Strategi Pengujian & Quality Gates**](./development/testing-strategy.md): Hierarki test dan ambang batas kelulusan CI. - 🀝 [**Panduan Kontribusi (`CONTRIBUTING.md`)**](../CONTRIBUTING.md): Standar commit git dan checklist Definition of Done. --- ### 4. Performa & Optimasi (Performance) - πŸ“Š [**Baseline Performa & Sumber Daya**](./performance/baseline.md): Spesifikasi Hostinger KVM 2, metrik terukur, dan alokasi RAM per service. - ⚑ [**Laporan Optimasi Sumber Daya**](./performance/optimization-report.md): Detail teknis GOMEMLIMIT, heap Nuxt, timeouts Go, dan rotasi log. --- ### 5. Deployment, Infrastruktur & Operasional (Deployment & Ops) - πŸ—ΊοΈ [**Topologi Produksi**](./deployment/production-topology.md): Diagram alur koneksi internet publik ke Hostinger VPS. - ☁️ [**Integrasi Cloudflare Tunnel**](./deployment/cloudflare-tunnel.md): Pemetaan hostname `erp-km`, `b2b-km`, `pos-km`, `api-km` ke port origin loopback. - 🐳 [**Containerization & Compose**](./deployment/containers.md): Multi-stage Dockerfiles dan konfigurasi `compose.prod.yml`. - 🚒 [**CI/CD & Deployment Runbook**](./deployment/ci-cd.md): Alur otomatisasi GitHub Actions ke GHCR. - πŸ”™ [**Prosedur Rollback Rilis**](./deployment/rollback.md): Panduan pembatalan rilis dalam waktu <3 menit. - πŸ’Ύ [**Backup & Disaster Recovery**](./deployment/backup-and-restore.md): Prosedur pencadangan dan pemulihan database. - πŸ”’ [**Security Baseline**](./security/security-baseline.md): Standar keamanan jaringan, non-root user, dan RBAC. - 🚨 [**Runbook Insiden Produksi**](./runbooks/production-incident.md): Langkah penanganan saat OOM, CPU spike, atau 502 error. --- ## 6. Audit & Reference Document (2026-10-18) A complete, evidence-based technical and operational reference was generated for commit `288b6ce` and lives alongside the documentation set above. - πŸ“˜ [**`KeluargaMart-Monorepo-Complete-Documentation.docx`**](./KeluargaMart-Monorepo-Complete-Documentation.docx) β€” 40 chapters, 14 appendices, 32 figures, 124 numbered tables. Covers every application, the full database data dictionary (92 tables / 1031 columns), all 373 API operations, the RBAC model, user and developer manuals, deployment, testing and a 24-entry findings register. - πŸ“‹ [**`audit/findings.md`**](./audit/findings.md) β€” the findings register on its own. - πŸ“Š [**`audit/coverage-matrix.csv`**](./audit/coverage-matrix.csv) β€” what was verified, and where. - βœ… [**`audit/verification-summary.json`**](./audit/verification-summary.json) β€” machine-readable record of every count, test result and runtime check performed during the audit. - 🧾 **Inventories:** [`database-inventory.csv`](./audit/database-inventory.csv), [`api-inventory.csv`](./audit/api-inventory.csv), [`route-inventory.csv`](./audit/route-inventory.csv). - πŸ–ΌοΈ **Diagrams:** editable sources in [`diagrams/`](./diagrams), renders in [`diagrams/rendered/`](./diagrams/rendered). - βš™οΈ **Generators:** [`audit/tools/`](./audit/tools) and [`docgen/`](./docgen). ### Rebuilding the document ```bash python3 docs/audit/tools/build_inventories.py python3 docs/audit/tools/build_coverage.py python3 docs/diagrams/gen_erd.py python3 docs/docgen/build_doc.py # requires python-docx + LibreOffice for page measurement ``` All counts and findings live in [`docgen/facts.py`](./docgen/facts.py). Edit that file, not the prose.