कदम-दर-कदम निर्देश

Python

हमारे Python के उदाहरण में, Flask फ़्रेमवर्क का इस्तेमाल किया गया है. दिए गए लिंक से, पूरा सोर्स कोड डाउनलोड किया जा सकता है.

अगर ज़रूरी हो, तो Python 3.7 या इसके बाद का वर्शन इंस्टॉल करें. साथ ही, पक्का करें कि pip उपलब्ध हो.

python3 -m ensurepip --upgrade

हमारा यह भी सुझाव है कि आप एक नया Python वर्चुअल एनवायरमेंट सेट अप करें और उसे चालू करें.

python3 -m venv .classroom-addon-env
source .classroom-addon-env/bin/activate

डाउनलोड किए गए उदाहरणों में, हर वॉकट्रू सबडायरेक्ट्री में requirements.txt होता है. pip का इस्तेमाल करके, ज़रूरी लाइब्रेरी तुरंत इंस्टॉल की जा सकती हैं. पहली बार इस्तेमाल करने के लिए ज़रूरी लाइब्रेरी इंस्टॉल करने के लिए, इन कमांड का इस्तेमाल करें.

cd flask/01-basic-app
pip install -r requirements.txt

Node.js

हमारे Node.js उदाहरण में, Express फ़्रेमवर्क का इस्तेमाल किया गया है. दिए गए लिंक से, पूरा सोर्स कोड डाउनलोड किया जा सकता है.

इस उदाहरण के लिए, Node.js v16.13 या इसके बाद का वर्शन ज़रूरी है.

npm का इस्तेमाल करके, ज़रूरी नोड मॉड्यूल इंस्टॉल करें.

npm install

Java

हमारे Java के उदाहरण में, Spring Boot फ़्रेमवर्क का इस्तेमाल किया गया है. दिए गए लिंक से, पूरा सोर्स कोड डाउनलोड किया जा सकता है.

अगर आपके कंप्यूटर पर Java 11+ पहले से इंस्टॉल नहीं है, तो इसे इंस्टॉल करें.

Spring Boot ऐप्लिकेशन, Gradle या Maven का इस्तेमाल करके बिल्ड को हैंडल कर सकते हैं और डिपेंडेंसी मैनेज कर सकते हैं. इस उदाहरण में मेवन रैपर शामिल है. इससे यह पक्का होता है कि मेवन को इंस्टॉल किए बिना ही, बिल्ड तैयार हो गया है.

जिस डायरेक्ट्री में आपने प्रोजेक्ट को डाउनलोड या क्लोन किया है उसमें ये निर्देश चलाएं. इससे यह पक्का किया जा सकेगा कि आपके पास प्रोजेक्ट चलाने के लिए ज़रूरी शर्तें पूरी हों.

java --version
./mvnw --version

इसके अलावा, Windows पर:

java -version
mvnw.cmd --version

Python

• डायरेक्ट्री रूट में ये फ़ाइलें मौजूद हैं:

  • main.py - यह Python ऐप्लिकेशन का एंट्री पॉइंट है. इस फ़ाइल में, सर्वर का वह कॉन्फ़िगरेशन डालें जिसका आपको इस्तेमाल करना है. इसके बाद, सर्वर शुरू करने के लिए इसे चलाएं.
  • requirements.txt - वेब ऐप्लिकेशन को चलाने के लिए ज़रूरी Python मॉड्यूल. इन्हें pip install -r requirements.txt का इस्तेमाल करके अपने-आप इंस्टॉल किया जा सकता है.

  • client_secret.json - Google Cloud से डाउनलोड की गई क्लाइंट सीक्रेट फ़ाइल. ध्यान दें कि यह उदाहरण संग्रह में शामिल नहीं है. आपको डाउनलोड की गई क्रेडेंशियल फ़ाइल का नाम बदलना चाहिए और उसे हर डायरेक्ट्री रूट में कॉपी करना चाहिए.

• config.py - Flask सर्वर के लिए कॉन्फ़िगरेशन के विकल्प.

• webapp डायरेक्ट्री में वेब ऐप्लिकेशन का कॉन्टेंट होता है. इसमें ये शामिल हैं:

• अलग-अलग पेजों के लिए Jinja टेंप्लेट वाली /templates/ डायरेक्ट्री.

• /static/ डायरेक्ट्री में इमेज, सीएसएस, और सहायक JavaScript फ़ाइलें.

• routes.py - वेब ऐप्लिकेशन के रास्तों के लिए हैंडलर के तरीके.

• __init__.py - यह webapp मॉड्यूल के लिए इनिशियलाइज़र है. यह इनिशियलाइज़र, Flask सर्वर को शुरू करता है. साथ ही, config.py में सेट किए गए कॉन्फ़िगरेशन विकल्पों को लोड करता है.

• किसी खास वॉकट्रू चरण के लिए ज़रूरी अतिरिक्त फ़ाइलें.

Node.js

वॉक्थ्रू का हर चरण, अपने <step> सब-फ़ोल्डर में मौजूद होता है. हर चरण में यह जानकारी शामिल होती है:

• JavaScript, सीएसएस, और इमेज जैसी स्टैटिक फ़ाइलें, ./<step>/public फ़ोल्डर में मौजूद होती हैं.
• Express राउटर, ./<step>/routes फ़ोल्डर में मौजूद होते हैं.
• HTML टेंप्लेट, ./<step>/views फ़ोल्डर में मिलते हैं.
• सर्वर ऐप्लिकेशन ./<step>/app.js है.

Java

प्रोजेक्ट डायरेक्ट्री में ये शामिल होते हैं:

• src.main डायरेक्ट्री में सोर्स कोड और कॉन्फ़िगरेशन होता है, ताकि ऐप्लिकेशन को सही तरीके से चलाया जा सके. इस डायरेक्ट्री में ये शामिल हैं: + java.com.addons.spring डायरेक्ट्री में Application.java और Controller.java फ़ाइलें होती हैं. Application.java फ़ाइल, ऐप्लिकेशन सर्वर को चलाने के लिए ज़िम्मेदार होती है. वहीं, Controller.java फ़ाइल, एंडपॉइंट लॉजिक को मैनेज करती है. + resources डायरेक्ट्री में templates डायरेक्ट्री होती है. इसमें एचटीएमएल और JavaScript फ़ाइलें होती हैं. इसमें application.properties फ़ाइल भी शामिल होती है. यह फ़ाइल, सर्वर को चलाने के लिए पोर्ट, कीस्टोर फ़ाइल का पाथ, और templates डायरेक्ट्री का पाथ तय करती है. इस उदाहरण में, resources डायरेक्ट्री में कीस्टोर फ़ाइल शामिल है. इसे अपनी पसंद के हिसाब से किसी भी जगह सेव किया जा सकता है. हालांकि, यह पक्का करें कि आपने application.properties फ़ाइल में पाथ को अपडेट कर दिया हो.
  • pom.xml में प्रोजेक्ट बनाने और ज़रूरी डिपेंडेंसी तय करने के लिए ज़रूरी जानकारी होती है.
  • .gitignore में ऐसे फ़ाइल नाम शामिल हैं जिन्हें git पर अपलोड नहीं किया जाना चाहिए. पक्का करें कि आपने इस .gitignore में अपने कीस्टोर का पाथ जोड़ा हो. यहां दिए गए उदाहरण में, यह secrets/*.p12 है. कीस्टोर के मकसद के बारे में यहां दिए गए सेक्शन में बताया गया है. दूसरे और इसके बाद के हर वॉकथ्रू के लिए, आपको अपनी client_secret.json फ़ाइल का पाथ भी शामिल करना चाहिए. इससे यह पक्का किया जा सकेगा कि आपने रिमोट रिपॉज़िटरी में अपने सीक्रेट शामिल न किए हों. तीसरे और इसके बाद के वॉकथ्रू के लिए, आपको H2 डेटाबेस फ़ाइल और फ़ाइल डेटास्टोर फ़ैक्ट्री का पाथ जोड़ना चाहिए. इन डेटा स्टोर को सेट अप करने के बारे में ज़्यादा जानकारी, बार-बार होने वाली विज़िट को मैनेज करने के बारे में तीसरे वॉकट्रू में मिल सकती है.
  • mvnw और mvnw.cmd, Unix और Windows के लिए Maven रैपर एक्ज़ीक्यूटेबल हैं. उदाहरण के लिए, Unix पर ./mvnw --version चलाने पर, Apache Maven के वर्शन के साथ-साथ अन्य जानकारी भी मिलती है.
  • .mvn डायरेक्ट्री में Maven रैपर के लिए कॉन्फ़िगरेशन होता है.

Python

OAuth क्रेडेंशियल

ऊपर बताए गए तरीके से, अपने OAuth क्रेडेंशियल बनाएं और उन्हें डाउनलोड करें. JSON फ़ाइल को रूट डायरेक्ट्री में, अपने ऐप्लिकेशन के सर्वर लॉन्च फ़ाइल के साथ रखें.

सर्वर को कॉन्फ़िगर करना

वेब सर्वर को चलाने के लिए, आपके पास कई विकल्प हैं. अपनी Python फ़ाइल के आखिर में, इनमें से कोई एक कोड जोड़ें:

1. localhost सुरक्षित नहीं है. ध्यान दें कि इसका इस्तेमाल सिर्फ़ ब्राउज़र विंडो में सीधे तौर पर टेस्टिंग के लिए किया जा सकता है. असुरक्षित डोमेन को Classroom ऐड-ऑन iframe में लोड नहीं किया जा सकता.

   if __name__ == "__main__":
     # Disable OAuthlib's HTTPs verification.
     os.environ["OAUTHLIB_INSECURE_TRANSPORT"] = "1"
   
     # Run the web app at http://localhost:5000.
     app.run(debug=True)
   

2. localhost को लॉक करें. आपको ssl_context आर्ग्युमेंट के लिए, एसएसएल कुंजी फ़ाइलों का टपल तय करना होगा.

   if __name__ == "__main__":
     # Run the web app at https://localhost:5000.
     app.run(host="localhost",
             ssl_context=("localhost.pem", "localhost-key.pem"),
             debug=True)
   

3. Gunicorn सर्वर. यह प्रोडक्शन-रेडी सर्वर या क्लाउड डिप्लॉयमेंट के लिए सही है. हमारा सुझाव है कि इस लॉन्च विकल्प के साथ इस्तेमाल करने के लिए, PORT एनवायरमेंट वैरिएबल सेट करें.

   if __name__ == "__main__":
     # Run the web app at https://<your domain>:<server_port>.
     # Defaults to https://<your domain>:8080.
     server_port = os.environ.get("PORT", "8080")
     app.run(debug=True, port=server_port, host="0.0.0.0")
   

सर्वर लॉन्च करना

अपने Python ऐप्लिकेशन को चलाकर, सर्वर को लॉन्च करें. इसे पिछले चरण में कॉन्फ़िगर किया गया था.

python main.py

अपने वेब ऐप्लिकेशन को ब्राउज़र में देखने के लिए, दिखने वाले यूआरएल पर क्लिक करें. इससे यह पुष्टि की जा सकेगी कि वह सही तरीके से काम कर रहा है.

Node.js

सर्वर को कॉन्फ़िगर करना

सर्वर को एचटीटीपीएस पर चलाने के लिए, आपको एक ऐसा सर्टिफ़िकेट बनाना होगा जिसका इस्तेमाल एचटीटीपीएस पर ऐप्लिकेशन चलाने के लिए किया जाता है. इन क्रेडेंशियल को रिपॉज़िटरी के रूट फ़ोल्डर में sslcert/cert.pem और sslcert/key.pem के तौर पर सेव किया जाना चाहिए. इन कुंजियों को अपने ओएस की-चेन में जोड़ना पड़ सकता है, ताकि आपका ब्राउज़र इन्हें स्वीकार कर सके.

पक्का करें कि आपकी .gitignore फ़ाइल में *.pem मौजूद हो, क्योंकि आपको फ़ाइल को git में सेव नहीं करना है.

सर्वर लॉन्च करना

ऐप्लिकेशन को इस निर्देश के साथ चलाया जा सकता है. इसके लिए, step01 की जगह उस सही चरण को डालें जिसे आपको सर्वर के तौर पर चलाना है. उदाहरण के लिए, 01-basic-app के लिए step01 और 02-sign-in के लिए step02.

npm run step01

या

npm run step02

इससे https://localhost:5000 पर वेब सर्वर लॉन्च होता है.

अपने टर्मिनल में Control + C की मदद से सर्वर को बंद किया जा सकता है.

Java

सर्वर को कॉन्फ़िगर करना

सर्वर को एचटीटीपीएस पर चलाने के लिए, आपको एक ऐसा सर्टिफ़िकेट बनाना होगा जिसका इस्तेमाल एचटीटीपीएस पर ऐप्लिकेशन चलाने के लिए किया जाता है.

लोकल डेवलपमेंट के लिए, mkcert का इस्तेमाल करें. mkcert इंस्टॉल करने के बाद, यहां दी गई कमांड से लोकल तौर पर सेव किया गया सर्टिफ़िकेट जनरेट होता है. इसका इस्तेमाल HTTPS पर किया जाता है.

mkcert -install
mkcert -pkcs12 -p12-file <path_to_keystore> <domain_name>

इस उदाहरण में, रिसॉर्स डायरेक्ट्री में कीस्टोर फ़ाइल शामिल है. इसे अपनी पसंद के हिसाब से किसी भी जगह पर सेव किया जा सकता है. हालांकि, यह पक्का करें कि आपने application.properties फ़ाइल में पाथ को अपडेट कर दिया हो. डोमेन का नाम वह डोमेन होता है जिस पर प्रोजेक्ट चलाया जाता है. उदाहरण के लिए, localhost.

पक्का करें कि आपकी .gitignore फ़ाइल में *.p12 मौजूद हो, क्योंकि आपको फ़ाइल को git में सेव नहीं करना है.

सर्वर लॉन्च करना

Application.java फ़ाइल में main तरीके को चलाकर सर्वर लॉन्च करें. उदाहरण के लिए, IntelliJ में src/main/java/com/addons/spring डायरेक्ट्री में जाकर, Application.java > Run 'Application' पर राइट क्लिक करें. इसके अलावा, Application.java फ़ाइल खोलकर, main(String[] args) मेथड सिग्नेचर के बाईं ओर मौजूद हरे ऐरो पर क्लिक करें. इसके अलावा, प्रोजेक्ट को टर्मिनल विंडो में भी चलाया जा सकता है:

./mvnw spring-boot:run

या Windows पर:

mvnw.cmd spring-boot:run

इससे सर्वर, https://localhost:5000 पर या application.properties में बताए गए पोर्ट पर लॉन्च होता है.