Vai al contenuto principale

Architettura

Queste pagine sono mappe di sistema tra repository: descrivono come un sistema principale di ChurchApps funziona dall'inizio alla fine, attraverso le app, i moduli dell'API e le librerie condivise, anziché come è configurato un singolo progetto. Leggile prima di modificare il comportamento di un sistema; leggi Configurazione per avviare un progetto e la sezione API per il riferimento a livello di endpoint.

L'ecosistema in breve​

ChurchApps comprende circa 20 repository indipendenti (non un monorepo). Le app client comunicano con un piccolo insieme di API di backend tramite HTTPS e WebSocket, e condividono il codice tramite pacchetti npm pubblicati nell'ambito @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)

Due regole strutturali determinano tutto ciò che è documentato in questa sezione:

  1. I moduli sono isolati. Ogni modulo dell'Api possiede il proprio database e le proprie tabelle; gli altri moduli e le app accedono ai suoi dati solo tramite i suoi endpoint REST. Vedi Struttura dei moduli.
  2. Il codice condiviso viene distribuito come pacchetti npm. Le app non importano mai il codice sorgente l'una dell'altra; tutto ciò che viene riutilizzato attraversa i confini dei repository tramite @churchapps/helpers, @churchapps/apphelper o @churchapps/apihelper. Vedi Librerie condivise.

Mappe di sistema​

PaginaCosa descriveAmbito
Notifiche e promemoriaCome qualsiasi cosa comunica qualcosa a una persona: le due porte di invio, la catena di escalation dei canali e il motore dei promemoriaApi (messaging), B1Admin, B1App
Architettura in tempo realeIl framework di distribuzione WebSocket alla base di chat, presenza e consegna in-appApi (messaging), tutte le app web
Notifiche push webIl canale di push del browser: chiavi VAPID, archiviazione delle iscrizioni, invioApi (messaging), tutte le app web
DonazioniFornitori di pagamento e gateway, flussi di donazione, fondi/lotti, webhook dei gatewayApi (giving), apphelper, B1App, B1Admin
Iscrizioni agli eventiIl modello commerciale delle iscrizioni: tipi di partecipanti, selezioni, codici sconto, pagamenti tramite il gateway delle donazioni e la lista d'attesaApi (content + giving), B1App, B1Admin
Check-inCheck-in da chiosco e self check-in, modello dei dati di presenza, instradamento nelle stanze, livello di sicurezza dei minori, stampa delle etichetteB1Checkin, B1App, B1Admin, Api (attendance + membership)
Creatore di siti webL'albero di pagine/sezioni/elementi, il contratto e i renderer dei tipi di elemento, il blog, le pagine con accesso limitato, la SEO e la generazione con IAApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Instradamento dei siti web e multi-sitoCome una richiesta viene associata a una chiesa e a un sito specifico, il modello dei dati multi-sito con siteId e il bordo dei domini personalizzati CaddyB1App, Api (membership + content), B1Admin
IntegrazioniLa superficie di estensione: OAuth, chiavi API, webhook, fornitori di contenuti, MCPApi, librerie condivise, app esterne
Registro di controllo e lotti annullabiliRegistrazione predefinita di ogni modifica al punto di controllo del controller, e il livello dei lotti che rende annullabili importazioni e azioni in bloccoApi (tutti i moduli), B1Admin, B1Transfer
MinistryStuffIl servizio a pagamento di archiviazione e crediti per SMS: identità tramite JWT condiviso, S2S con chiave di servizio, punti di integrazione dei fornitori di SMS e archiviazione, fatturazione StripeMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), pacchetti texting/apihelper, B1Admin
Archiviazione con mezzi propriLe chiese collegano Google Drive, Dropbox, OneDrive o un bucket compatibile con S3 per caricamenti oltre i 100 MB gratuiti: connessione OAuth, forme di caricamento per fornitore, reindirizzamento pubblico per il downloadApi (content + membership), pacchetti helpers/apphelper, B1Admin, B1App
Content CommonsIl nucleo condiviso di asset e invii alla base dei contenuti generati dagli utenti tra prodotti, e l'unica coda di moderazione riservata allo staff in Server Admin di B1AdminApi (modulo commons), B1Admin, WorshipCommons, Lessons.church, FreeShow
Suggerimento

Quando una modifica altera il funzionamento di uno di questi sistemi — non solo una pagina all'interno di una singola app — la relativa mappa di sistema qui presente deve essere aggiornata nello stesso lavoro. Questo mantiene la sezione affidabile come primo punto di riferimento per i nuovi collaboratori.

Proposte​

Questi documenti descrivono lavori proposti da sottoporre a revisione, e non il comportamento disponibile del prodotto.

PropostaCosa descrive
BYOK per TwilioAccount, chiavi, servizio e numero di telefono di proprietà della chiesa; ambito dell'integrazione, consenso, consegna, stime e verifiche di rilascio
Bozza di onboarding delle chiese per TwilioImpostazioni proposte per il modulo di iscrizione di B1, esempi di campagne specifiche per chiesa e liste di controllo per l'approvazione e il funzionamento