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

सेटअप

यह अनुभाग ChurchApps प्रोजेक्ट्स के लिए स्थानीय डेवलपमेंट वातावरण सेट करने की प्रक्रिया बताता है। आप त्वरित विकास के लिए अपने फ्रंटएंड को साझा डेमो APIs की ओर इंगित कर सकते हैं, या बैकएंड कार्य के लिए पूरा स्टैक स्थानीय रूप से चला सकते हैं।

दो तरीके​

स्टैक की कितनी आवश्यकता है, इसके आधार पर स्थानीय रूप से विकास करने के दो तरीके हैं:

1. डेमो APIs की ओर इंगित करें (सबसे आसान)​

यदि आप फ्रंटएंड प्रोजेक्ट (वेब ऐप, मोबाइल ऐप, या डेस्कटॉप ऐप) पर काम कर रहे हैं, तो सबसे तेज़ रास्ता है अपने स्थानीय ऐप को साझा डेमो APIs की ओर इंगित करना। इसके लिए किसी डेटाबेस या बैकएंड सेटअप की आवश्यकता नहीं है।

डेमो API का बेस URL है:

https://api.demo.churchapps.org

हर API मॉड्यूल इस बेस के अंतर्गत एक पथ पर उपलब्ध है, उदाहरण के लिए:

https://api.demo.churchapps.org/membership
https://api.demo.churchapps.org/attendance
https://api.demo.churchapps.org/giving

डेमो वातावरण main का नवीनतम कोड चलाता है, और इसका नमूना डेटा हर रात फिर से भरा जाता है, इसलिए वहाँ आप जो भी बनाते हैं उसके टिके रहने की उम्मीद न करें। (पूर्व स्टेजिंग वातावरण, api.staging.churchapps.org, अब बंद कर दिया गया है। कुछ नमूना .env फ़ाइलों में अभी भी स्टेजिंग URLs हो सकते हैं -- उन्हें demo या local URLs से बदल दें।)

सुझाव

यह तरीका कुछ ही मिनटों में फ्रंटएंड बदलाव शुरू करने देता है। अधिकांश योगदानकर्ताओं के लिए यह अनुशंसित रास्ता है।

2. सब कुछ स्थानीय रूप से चलाएं​

यदि आपको API कोड बदलना है या ऑफ़लाइन काम करना है, तो आप पूरा स्टैक स्थानीय रूप से चला सकते हैं। इसके लिए MySQL 8.0+ और अतिरिक्त कॉन्फ़िगरेशन की आवश्यकता होती है। विस्तृत निर्देशों के लिए API लोकल सेटअप गाइड देखें।

शुरुआत करना​

इन पेजों को क्रम से फ़ॉलो करें:

  1. पूर्वापेक्षाएँ -- आवश्यक टूल्स इंस्टॉल करें (Node.js, Git, MySQL, आदि)
  2. प्रोजेक्ट अवलोकन -- समझें कि कौन-से प्रोजेक्ट मौजूद हैं और वे क्या करते हैं
  3. एनवायरनमेंट वेरिएबल्स -- अपनी .env फ़ाइलें कॉन्फ़िगर करें ताकि सब कुछ आपस में जुड़ जाए
जानकारी

हर ChurchApps प्रोजेक्ट एक स्वतंत्र Git रिपॉजिटरी है। आपको केवल उन्हीं प्रोजेक्ट(ों) को क्लोन करने की आवश्यकता है जिन पर आप काम करना चाहते हैं।