Siirry pääsisällölle

Arkkitehtuuri

Nämä sivut ovat järjestelmäkarttoja eri repositorioiden yli: ne dokumentoivat, miten ChurchAppsin keskeinen järjestelmä toimii alusta loppuun sovellusten, API-moduulien ja jaettujen kirjastojen kautta. Ne eivät kuvaa, miten yksittäinen projekti on määritetty. Lue ne ennen järjestelmän toiminnan muuttamista. Lue Asennus, jos haluat saada projektin käyntiin, ja API-osio päätepistekohtaista viitettä varten.

Ekosysteemi yhdellä silmäyksellä​

ChurchAppsissa on noin 20 itsenäistä repositoriota (ei monorepo). Asiakassovellukset puhuvat pienen joukon taustapalvelu-API:iden kanssa HTTPS:n ja WebSocketin kautta. Ne jakavat koodia npm-paketeilla, jotka on julkaistu @churchapps-nimiavaruudessa.

┌────────────────────────────────┐            ┌──────────────────────────────────────────────┐
│ 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)

Kaksi rakenteellista sääntöä muokkaa kaikkea tämän osion dokumentaatiota:

  1. Moduulit ovat eristettyjä. Jokainen Api-moduuli omistaa oman tietokantansa ja taulunsa. Muut moduulit ja sovellukset pääsevät sen dataan vain sen REST-päätepisteiden kautta. Katso Moduulirakenne.
  2. Jaettu koodi toimitetaan npm-paketteina. Sovellukset eivät tuo toistensa lähdekoodia. Uudelleenkäytettävä koodi ylittää repositoriorajat @churchapps/helpers-, @churchapps/apphelper)- tai @churchapps/apihelper-paketin kautta. Katso Jaetut kirjastot.

Järjestelmäkartat​

SivuMitä se kattaaUlottuvuus
Ilmoitukset ja muistutuksetMiten mikä tahansa kertoo henkilölle jotain: kaksi lähetysovea, kanavan eskalaatioketju ja muistutusmoottoriApi (messaging), B1Admin, B1App
Reaaliaikainen arkkitehtuuriWebSocket-toimituskehys, jonka varassa ovat chat, läsnäolo ja sovelluksen sisäinen toimitusApi (messaging), kaikki web-sovellukset
Web Push -ilmoituksetSelaimen push-kanava: VAPID-avaimet, tilausten tallennus ja toimitusApi (messaging), kaikki web-sovellukset
LahjoituksetMaksunvälittäjät ja -yhdyskäytävät, lahjoitusvirrat, rahastot ja erät, yhdyskäytävän webhookitApi (giving), apphelper, B1App, B1Admin
TapahtumarekisteröinnitRekisteröintien kaupallinen malli: osallistujatyypit, valinnat, alennuskoodit, maksut lahjoitusyhdyskäytävän kautta ja odotuslistaApi (content + giving), B1App, B1Admin
SisäänkirjautumisetKioski- ja itsepalvelusisäänkirjautuminen, osallistumistietomalli, huonereititys, lasten turvallisuuskerros ja tarrojen tulostusB1Checkin, B1App, B1Admin, Api (attendance + membership)
VerkkosivurakentajaSivun, osion ja elementin puu, elementtityypin sopimus ja renderöijät, blogi, käyttöoikeuspohjaiset sivut, SEO ja tekoälygenerointiApi (content), AskApi, helpers/apphelper, B1Admin, B1App
Verkkosivujen reititys ja monisivustotMiten pyyntö ratkeaa seurakunnaksi ja tietyksi sivustoksi, monisivustojen siteId-tietomalli ja Caddy-mukautettujen domainien reunaB1App, Api (membership + content), B1Admin
IntegraatiotLaajennuspinta: OAuth, API-avaimet, webhookit, sisältöpalvelut ja MCPApi, jaetut kirjastot, ulkoiset sovellukset
Tapahtumaloki ja peruttavat erätOletuksena päällä oleva kaikkien muutosten auditointi kontrollerin pääsykohdassa sekä erätaso, joka tekee tuonneista ja joukkotoimista peruttaviaApi (kaikki moduulit), B1Admin, B1Transfer
MinistryStuffMaksullinen tallennus- ja tekstiviestiluottopalvelu: jaettu JWT-identiteetti, palveluavaimella tehtävä S2S-viestintä, tekstiviesti- ja tallennuspalveluntarjoajien saumat sekä Stripe-laskutusMinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper-paketit, B1Admin
Omat tallennustilat (Bring-Your-Own Storage)Seurakunnat yhdistävät Google Driveen, Dropboxiin, OneDriveen tai S3-yhteensopivaan säilöön ilmaisen 100 Mt:n ylittäviä latauksia varten: OAuth-yhdistäminen, palveluntarjoajakohtaiset latausmuodot ja julkinen latausuudelleenohjausApi (content + membership), helpers/apphelper-paketit, B1Admin, B1App
SisältöyhteisöJaettu resurssi- ja lähetysrunko tuotteiden välisen käyttäjien luoman sisällön taustalla sekä yksi ainoa vain henkilökunnalle tarkoitettu moderointijono B1Admin Server AdminissaApi (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow
vihje

Kun muutos muuttaa jonkin näistä järjestelmistä toimintaa, ei vain yhden sovelluksen sisällä olevaa sivua, vastaava järjestelmäkartta tässä on päivitettävä samassa työssä. Näin tämä osio pysyy luotettavana ensimmäisenä pysäkkinä uusille osallistujille.

Ehdotukset​

Nämä asiakirjat kuvaavat ehdotettua työtä arvioitavaksi eivätkä saatavilla olevaa tuotteen toimintaa.

EhdotusMitä se kattaa
Twilio BYOKSeurakunnan omistama tili, avaimet, palvelu ja puhelinnumero; integraation laajuus, suostumus, toimitus, arviot ja julkaisutarkistukset
Twilio-seurakuntaliittymän luonnosEhdotetut B1-rekisteröintilomakkeen asetukset, seurakuntakohtaiset kampanjaesimerkit sekä hyväksymis- ja toimintatarkistuslistat