Arsitektur
Halaman-halaman ini adalah peta sistem lintas repositori: halaman ini mendokumentasikan cara kerja sistem inti ChurchApps dari awal hingga akhir, mencakup aplikasi, modul API, dan pustaka bersama, dan bukan cara menyiapkan satu proyek tertentu. Bacalah halaman ini sebelum mengubah perilaku suatu sistem. Baca Pengaturan untuk menjalankan proyek, dan bagian API untuk referensi tingkat endpoint.
Ekosistem sekilas
ChurchApps terdiri dari ~20 repositori independen (bukan monorepo). Aplikasi klien berkomunikasi dengan sejumlah kecil API backend melalui HTTPS dan WebSocket, serta berbagi kode melalui paket npm yang dipublikasikan di bawah scope @churchapps.
┌────────────────────────────────┐ ┌──────────────────────────────────────────────┐
│ Clients │ │ Api — core modular monolith (AWS Lambda) │
│ │ │ │
│ B1Admin staff dashboard │ HTTPS │ membership attendance content │
│ B1App member portal + │ ─────────▶ │ giving messaging doing │
│ church websites │ │ │
│ B1Checkin check-in kiosk │ ◀───WS───▶ │ one MySQL database per module (6 total) │
│ │ └──────────────────────────────────────────────┘
│ FreePlay TV content player │ ┌──────────────────────────────────────────────┐
└───────────────┬────────────────┘ │ LessonsApi — Lessons.church backend │
│ └──────────────────────────────────────────────┘
│ shared code via npm (@churchapps/*)
▼
helpers (cross-app interfaces) · apphelper (React components) · apihelper (Express/server utilities)
Dua aturan struktural membentuk semua yang didokumentasikan di bagian ini:
- Modul bersifat terisolasi. Setiap modul Api memiliki basis data dan tabelnya sendiri. Modul lain dan aplikasi hanya dapat mengakses datanya melalui endpoint REST. Lihat Struktur Modul.
- Kode bersama dikirim sebagai paket npm. Aplikasi tidak pernah mengimpor sumber satu sama lain. Apa pun yang digunakan kembali melintasi batas repositori melalui
@churchapps/helpers,@churchapps/apphelper, atau@churchapps/apihelper. Lihat Pustaka Bersama.
Peta sistem
| Halaman | Yang dibahas | Mencakup |
|---|---|---|
| Notifikasi & Pengingat | Bagaimana sesuatu memberi tahu seseorang: dua pintu pengiriman, rantai eskalasi saluran, dan mesin pengingat | Api (messaging), B1Admin, B1App |
| Arsitektur Real-time | Kerangka pengiriman WebSocket di balik chat, presence, dan pengiriman dalam aplikasi | Api (messaging), semua aplikasi web |
| Notifikasi Web Push | Saluran push browser: kunci VAPID, penyimpanan langganan, dan pengiriman | Api (messaging), semua aplikasi web |
| Persembahan | Penyedia pembayaran dan gateway, alur donasi, dana/batch, dan webhook gateway | Api (giving), apphelper, B1App, B1Admin |
| Pendaftaran Acara | Model perdagangan pendaftaran: jenis peserta, pilihan, kode diskon, pembayaran melalui gateway persembahan, dan daftar tunggu | Api (content + giving), B1App, B1Admin |
| Check-In | Check-in kiosk dan mandiri, model data kehadiran, perutean ruangan, lapisan keamanan anak, dan pencetakan label | B1Checkin, B1App, B1Admin, Api (attendance + membership) |
| Pembangun Situs Web | Pohon halaman/bagian/elemen, kontrak dan renderer jenis elemen, blog, halaman dengan akses terbatas, SEO, dan pembuatan AI | Api (content), AskApi, helpers/apphelper, B1Admin, B1App |
| Perutean Situs Web & Multi-Situs | Cara sebuah permintaan diarahkan ke gereja dan situs tertentu, model data siteId multi-situs, dan edge domain kustom Caddy | B1App, Api (membership + content), B1Admin |
| Integrasi | Permukaan ekstensi: OAuth, kunci API, webhook, penyedia konten, MCP | Api, pustaka bersama, aplikasi eksternal |
| Log Audit & Batch yang Dapat Dibatalkan | Audit default-aktif atas setiap mutasi di titik kontrol controller, dan lapisan batch yang membuat impor serta tindakan massal dapat dibatalkan | Api (semua modul), B1Admin, B1Transfer |
| MinistryStuff | Layanan penyimpanan berbayar dan kredit SMS: identitas shared-JWT, S2S service-key, titik sambung penyedia SMS dan penyimpanan, penagihan Stripe | MinistryStuffApi, MinistryStuffWeb, Api (content + messaging), paket texting/apihelper, B1Admin |
| Penyimpanan Bawa Sendiri | Gereja menautkan Google Drive, Dropbox, OneDrive, atau bucket kompatibel S3 untuk unggahan di atas 100MB gratis: koneksi OAuth, bentuk unggahan per penyedia, dan pengalihan unduhan publik | Api (content + membership), paket helpers/apphelper, B1Admin, B1App |
| Content Commons | Tulang punggung aset dan pengajuan bersama di balik konten buatan pengguna lintas produk, serta antrean moderasi tunggal khusus staf di Server Admin B1Admin | Api (modul commons), B1Admin, WorshipCommons, Lessons.church, FreeShow |
Ketika perubahan mengubah cara kerja salah satu sistem ini, bukan hanya halaman di dalam satu aplikasi, peta sistem yang sesuai di sini harus diperbarui dalam upaya yang sama. Hal itu menjaga bagian ini tetap menjadi sumber rujukan pertama yang dapat dipercaya bagi kontributor baru.
Usulan
Dokumen-dokumen ini menjelaskan pekerjaan yang diusulkan untuk ditinjau, bukan perilaku produk yang tersedia.
| Usulan | Yang dibahas |
|---|---|
| Twilio BYOK | Akun, kunci, layanan, dan nomor telepon milik gereja; cakupan integrasi, persetujuan, pengiriman, estimasi, dan pemeriksaan rilis |
| Draf orientasi gereja Twilio | Pengaturan formulir pendaftaran B1 yang diusulkan, contoh kampanye khusus gereja, dan daftar periksa persetujuan serta operasional |