मुख्य सामग्री पर जाएं

API

ChurchApps API एक मॉड्यूलर मोनोलिथ है -- एक ही कोडबेस जो छह डेटा मॉड्यूल की सेवा करता है, जिनमें से हर एक का अपना डेटाबेस है। यह आर्किटेक्चर माइक्रोसर्विसेज़ के संगठनात्मक लाभ (स्पष्ट सीमाएँ, स्वतंत्र डेटा स्टोर) को एकल डिप्लॉयमेंट की परिचालन सरलता के साथ देता है।

मॉड्यूल​

मॉड्यूलउद्देश्य
Membershipलोग, समूह, परिवार (households), अनुमतियाँ
Attendanceसेवाएँ, सत्र, चेक-इन रिकॉर्ड
Contentपृष्ठ, सेक्शन, एलिमेंट, स्ट्रीमिंग
Givingदान, फंड, भुगतान प्रसंस्करण
Messagingबातचीत, सूचनाएँ, ईमेल
Doingकार्य, योजनाएँ, असाइनमेंट

टेक स्टैक​

  • Runtime: TypeScript (ES modules) के साथ Node.js 24.x
  • Framework: Express
  • Dependency Injection: Inversify (decorator-आधारित routing)
  • Database: MySQL -- हर मॉड्यूल के लिए एक डेटाबेस, हर एक का अपना connection pool
  • Auth: CustomAuthProvider के माध्यम से JWT-आधारित प्रमाणीकरण
  • Deployment: Serverless Framework v3 के माध्यम से AWS Lambda

Ports​

प्रोटोकॉलPortविवरण
HTTP8084मुख्य REST API
WebSocket8087रियल-टाइम सॉकेट कनेक्शन

Lambda Functions​

जब AWS पर डिप्लॉय किया जाता है, तो API छह Lambda functions के रूप में चलता है:

  • web -- सभी HTTP अनुरोध संभालता है
  • socket -- WebSocket कनेक्शन प्रबंधित करता है
  • timer15Min -- ईमेल सूचनाओं के लिए हर 30 मिनट पर चलता है (नाम ऐतिहासिक है)
  • timerMidnight -- डाइजेस्ट ईमेल और रखरखाव कार्यों के लिए रोज़ चलता है
  • timerScheduledTasks -- देय स्वचालन और अतिदेय वर्कफ़्लो प्रसंस्करण के लिए रोज़ चलता है
  • timerWebhooks -- कतारबद्ध आउटबाउंड webhooks भेजने के लिए हर मिनट चलता है

साझा लाइब्रेरी​

API दो साझा ChurchApps पैकेजों पर निर्भर है:

  • @churchapps/helpers -- बुनियादी utilities (DateHelper, ApiHelper, आदि)
  • @churchapps/apihelper -- Express सर्वर utilities, जिनमें auth, database helpers, और AWS एकीकरण शामिल हैं
जानकारी

API ES modules (package.json में "type": "module") का उपयोग करता है। सुनिश्चित करें कि आपके imports ES module सिंटैक्स का उपयोग करते हैं।

इस अनुभाग में​

  • Local Setup -- API को स्थानीय रूप से क्लोन, कॉन्फ़िगर और चलाएँ
  • Database -- मॉड्यूल-प्रति-डेटाबेस आर्किटेक्चर, schema scripts, और डेटा access पैटर्न
  • Module Structure -- कंट्रोलर, रिपॉज़िटरी, मॉडल, और प्रमाणीकरण
  • API Keys -- स्क्रिप्ट और कनेक्टरों के लिए personal access tokens
  • Connected Apps (OAuth) -- तृतीय-पक्ष ऐप्स के लिए मल्टी-टेनेंट OAuth प्रवाह
  • Webhooks -- बाहरी सिस्टमों को push इवेंट सूचनाएँ
  • MCP Server -- Model Context Protocol endpoint जो API को AI सहायकों के लिए उपलब्ध कराता है
  • Endpoint Reference -- सभी मॉड्यूलों के लिए पूर्ण REST API दस्तावेज़ीकरण