आर्किटेक्चर
ये पेज क्रॉस-रिपो सिस्टम मैप हैं: ये दिखाते हैं कि कोई मुख्य ChurchApps सिस्टम शुरू से अंत तक कैसे काम करता है, ऐप्स, API मॉड्यूल और साझा लाइब्रेरी में फैला हुआ। ये यह नहीं बताते कि कोई एक प्रोजेक्ट कैसे सेट अप होता है। किसी सिस्टम का व्यवहार बदलने से पहले इन्हें पढ़ें। कोई प्रोजेक्ट चालू करने के लिए सेटअप पढ़ें और एंडपॉइंट-स्तर की जानकारी के लिए API सेक्शन देखें।
इकोसिस्टम एक नज़र में
ChurchApps लगभग 20 स्वतंत्र रिपॉज़िटरी है (यह मोनोरेपो नहीं है)। क्लाइंट ऐप्स HTTPS और WebSocket के ज़रिए बैकएंड APIs के एक छोटे सेट से बात करते हैं, और @churchapps स्कोप के तहत प्रकाशित npm पैकेज के ज़रिए कोड साझा करते हैं।
┌────────────────────────────────┐ ┌──────────────────────────────────────────────┐
│ 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)
इस सेक्शन में दस्तावेज़ीकृत हर चीज़ को आकार देने वाले दो संरचनात्मक नियम:
- मॉड्यूल अलग-थलग हैं। हर Api मॉड्यूल अपना डेटाबेस और अपनी टेबल रखता है। अन्य मॉड्यूल और ऐप्स उसके डेटा तक केवल उसके REST एंडपॉइंट्स के ज़रिए पहुँचते हैं। देखें मॉड्यूल संरचना।
- साझा कोड npm पैकेज के रूप में आता है। ऐप्स एक-दूसरे का सोर्स कोड इम्पोर्ट नहीं करते। जो भी दोबारा उपयोग होता है, वह
@churchapps/helpers,@churchapps/apphelperया@churchapps/apihelperके ज़रिए रिपो की सीमाएँ पार करता है। देखें साझा लाइब्रेरी।
सिस्टम मैप
| पेज | क्या कवर करता है | किन प्रणालियों में फैला है |
|---|---|---|
| सूचनाएँ और रिमाइंडर | कोई व्यक्ति को कुछ कैसे बताता है: दो डिस्पैच द्वार, चैनल एस्केलेशन श्रृंखला, और रिमाइंडर इंजन | Api (messaging), B1Admin, B1App |
| रियल-टाइम आर्किटेक्चर | चैट, प्रेज़ेंस और इन-ऐप डिलीवरी के पीछे का WebSocket डिलीवरी फ़्रेमवर्क | Api (messaging), सभी वेब ऐप्स |
| वेब पुश नोटिफ़िकेशन | ब्राउज़र पुश चैनल: VAPID कुंजियाँ, सब्सक्रिप्शन स्टोरेज, डिलीवरी | Api (messaging), सभी वेब ऐप्स |
| दान (Giving) | भुगतान प्रदाता और गेटवे, दान प्रवाह, फ़ंड और बैच, गेटवे वेबहुक | Api (giving), apphelper, B1App, B1Admin |
| इवेंट रजिस्ट्रेशन | रजिस्ट्रेशन कॉमर्स मॉडल: attendee प्रकार, चयन, डिस्काउंट कोड, दान गेटवे के ज़रिए भुगतान, और वेटलिस्ट | Api (content + giving), B1App, B1Admin |
| चेक-इन | किओस्क और सेल्फ़ चेक-इन, उपस्थिति डेटा मॉडल, रूम रूटिंग, चाइल्ड-सेफ़्टी लेयर, लेबल प्रिंटिंग | B1Checkin, B1App, B1Admin, Api (attendance + membership) |
| वेबसाइट बिल्डर | पेज, सेक्शन और एलिमेंट ट्री, एलिमेंट-टाइप कॉन्ट्रैक्ट और रेंडरर, ब्लॉग, एक्सेस-गेटेड पेज, SEO, और AI जनरेशन | Api (content), AskApi, helpers/apphelper, B1Admin, B1App |
| वेबसाइट रूटिंग और मल्टी-साइट | अनुरोध किसी चर्च और विशेष साइट तक कैसे पहुँचता है, मल्टी-साइट siteId डेटा मॉडल, और Caddy कस्टम-डोमेन एज | B1App, Api (membership + content), B1Admin |
| इंटीग्रेशन | एक्सटेंशन सतह: OAuth, API कुंजियाँ, वेबहुक, कंटेंट प्रदाता, MCP | Api, साझा लाइब्रेरी, बाहरी ऐप्स |
| ऑडिट लॉग और पूर्ववत-योग्य बैच | कंट्रोलर चोक पॉइंट पर हर म्यूटेशन की डिफ़ॉल्ट-ऑन ऑडिटिंग, और वह बैच लेयर जो इम्पोर्ट और बल्क एक्शन को पूर्ववत करने योग्य बनाती है | Api (सभी मॉड्यूल), B1Admin, B1Transfer |
| MinistryStuff | सशुल्क स्टोरेज और टेक्स्टिंग-क्रेडिट सेवा: shared-JWT पहचान, service-key S2S, टेक्स्टिंग और स्टोरेज प्रदाता सीम, Stripe बिलिंग | MinistryStuffApi, MinistryStuffWeb, Api (content + messaging), texting/apihelper packages, B1Admin |
| अपना स्टोरेज लाएँ (Bring-Your-Own Storage) | चर्च मुफ़्त 100MB से आगे के अपलोड के लिए Google Drive, Dropbox, OneDrive या S3-संगत बकेट लिंक कर सकते हैं: OAuth कनेक्ट, प्रति-प्रदाता अपलोड आकार, सार्वजनिक डाउनलोड रीडायरेक्ट | Api (content + membership), helpers/apphelper packages, B1Admin, B1App |
| कंटेंट कॉमन्स | क्रॉस-प्रोडक्ट यूज़र-जनित कंटेंट के पीछे साझा एसेट और सबमिशन रीढ़, और B1Admin Server Admin में केवल स्टाफ़ के लिए एकमात्र मॉडरेशन कतार | Api (commons module), B1Admin, WorshipCommons, Lessons.church, FreeShow |
जब कोई बदलाव इनमें से किसी सिस्टम के काम करने के तरीके को बदलता है, सिर्फ़ किसी एक ऐप के भीतर के पेज को नहीं, तो यहाँ का संबंधित सिस्टम मैप उसी प्रयास में अपडेट होना चाहिए। इससे यह सेक्शन नए योगदानकर्ताओं के लिए भरोसेमंद पहला पड़ाव बना रहता है।
प्रस्ताव
ये दस्तावेज़ उपलब्ध उत्पाद व्यवहार के बजाय समीक्षा के लिए प्रस्तावित कार्य का वर्णन करते हैं।
| प्रस्ताव | क्या कवर करता है |
|---|---|
| Twilio BYOK | चर्च-स्वामित्व वाला खाता, कुंजियाँ, सेवा और फ़ोन नंबर; इंटीग्रेशन का दायरा, सहमति, डिलीवरी, अनुमान और रिलीज़ जाँच |
| Twilio चर्च ऑनबोर्डिंग ड्राफ़्ट | प्रस्तावित B1 साइनअप-फ़ॉर्म सेटिंग्स, चर्च-विशिष्ट कैंपेन के उदाहरण, और अनुमोदन और संचालन की चेकलिस्ट |