Przejdź do zawartości głównej

Architektura

Te strony to mapy systemów obejmujące wiele repozytoriów: opisują, jak podstawowy system ChurchApps działa od początku do końca — w aplikacjach, modułach API i wspólnych bibliotekach — a nie jak skonfigurować pojedynczy projekt. Przeczytaj je przed zmianą działania systemu; przeczytaj Konfigurację, aby uruchomić projekt, oraz sekcję API jako dokumentację na poziomie endpointów.

Ekosystem w skrócie​

ChurchApps to ok. 20 niezależnych repozytoriów (a nie monorepo). Aplikacje kliencki komunikują się z niewielkim zestawem backendowych API przez HTTPS i WebSocket, a kod współdzielą poprzez pakiety npm publikowane w zakresie @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)

Dwie zasady strukturalne określają wszystko, co opisano w tej sekcji:

  1. Moduły są odizolowane. Każdy moduł Api posiada własną bazę danych i tabele; inne moduły i aplikacje mają dostęp do jego danych wyłącznie przez jego endpointy REST. Zobacz Strukturę modułu.
  2. Wspólny kod jest dostarczany jako pakiety npm. Aplikacje nigdy nie importują kodu źródłowego innych aplikacji; wszystko, co jest ponownie używane, przekracza granice repozytoriów przez @churchapps/helpers, @churchapps/apphelper lub @churchapps/apihelper. Zobacz Wspólne biblioteki.

Mapy systemu​

StronaCo obejmujeZakres
Notifications & RemindersJak system przekazuje osobie informację: dwa punkty wysyłki, łańcuch eskalacji kanałów oraz silnik przypomnieńApi (messaging), B1Admin, B1App
Real-time ArchitectureFramework dostarczania WebSocket stojący za czatem, statusem obecności i dostarczaniem w aplikacjiApi (messaging), all web apps
Web Push NotificationsKanał powiadomień push w przeglądarce: klucze VAPID, przechowywanie subskrypcji, dostarczanieApi (messaging), all web apps
GivingDostawcy płatności i bramki, przepływy darowizn, fundusze/partie, webhooki bramekApi (giving), apphelper, B1App, B1Admin
Event RegistrationsModel handlowy rejestracji: typy uczestników, wybory, kody rabatowe, płatności przez bramkę darowizn oraz listę oczekującychApi (content + giving), B1App, B1Admin
Check-InsZameldowanie na kiosku i samodzielne, model danych frekwencji, kierowanie do sal, warstwa bezpieczeństwa dzieci, drukowanie etykietB1Checkin, B1App, B1Admin, Api (attendance + membership)
Website BuilderDrzewo stron/sekcji/elementów, kontrakt typów elementów i renderery, blog, strony z kontrolowanym dostępem, SEO oraz generowanie AIApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Website Routing & Multi-SiteJak żądanie trafia do konkretnego kościoła i witryny, model danych wielowitrynowych z siteId oraz brzeg domen niestandardowych CaddyB1App, Api (membership + content), B1Admin
IntegrationsPowierzchnia rozszerzeń: OAuth, klucze API, webhooki, dostawcy treści, MCPApi, shared libraries, external apps
Audit Log & Undoable BatchesDomyślnie włączony audyt każdej modyfikacji w punkcie kontrolera oraz warstwa partii, dzięki której importy i operacje zbiorcze można cofnąćApi (all modules), B1Admin, B1Transfer
MinistryStuffPłatna usługa przechowywania i kredytów SMS: tożsamość oparta na wspólnym JWT, S2S z kluczem usługi, punkty styku dostawców SMS i przechowywania, rozliczenia StripeMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper packages, B1Admin
Bring-Your-Own StorageKościoły łączą Dysk Google, Dropbox, OneDrive lub kontener zgodny z S3 w celu przesyłania plików ponad darmowy limit 100 MB: połączenie OAuth, kształty przesyłania dla poszczególnych dostawców, publiczne przekierowanie pobieraniaApi (content + membership), helpers/apphelper packages, B1Admin, B1App
Content CommonsWspólny szkielet zasobów i zgłoszeń leżący u podstaw treści tworzonych przez użytkowników w wielu produktach oraz jedyna kolejka moderacji dostępna tylko dla personelu w B1Admin Server AdminApi (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow
porada

Gdy zmiana modyfikuje działanie jednego z tych systemów — a nie tylko jednej strony w obrębie aplikacji — odpowiadającą mu mapę systemu należy zaktualizować w ramach tej samej pracy. Dzięki temu ta sekcja pozostaje wiarygodnym pierwszym punktem odniesienia dla nowych współtwórców.

Propozycje​

Te dokumenty opisują proponowane prace do przeglądu, a nie dostępne funkcjonalności produktu.

PropozycjaCo obejmuje
Twilio BYOKKonto należące do kościoła, klucze, usługa i numer telefonu; zakres integracji, zgoda, dostarczanie, szacunki oraz kontrole wydania
Twilio church onboarding draftProponowane ustawienia formularza rejestracji B1, przykłady kampanii dla kościołów oraz listy kontrolne zatwierdzania i eksploatacji