راهپیمایی ها

پایتون

مثال پایتون ما از چارچوب Flask استفاده می‌کند. می‌توانید کد منبع کامل را از لینک‌های ارائه شده دانلود کنید.

در صورت لزوم، پایتون ۳.۷+ را نصب کنید و مطمئن شوید که pip در دسترس است.

python3 -m ensurepip --upgrade

همچنین توصیه می‌کنیم که یک محیط مجازی پایتون جدید راه‌اندازی و فعال کنید.

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 ما از فریم‌ورک Express استفاده می‌کند. می‌توانید کد منبع کامل را از لینک‌های ارائه شده دانلود کنید.

این مثال به Node.js نسخه ۱۶.۱۳ یا بالاتر نیاز دارد.

ماژول‌های گره مورد نیاز را با استفاده از npm نصب کنید.

npm install

جاوا

مثال جاوای ما از چارچوب Spring Boot استفاده می‌کند. می‌توانید کد منبع کامل را از لینک‌های ارائه شده دانلود کنید.

اگر جاوا ۱۱+ را روی دستگاه خود نصب ندارید، آن را نصب کنید.

برنامه‌های Spring Boot می‌توانند از Gradle یا Maven برای مدیریت ساخت‌ها و وابستگی‌ها استفاده کنند. این مثال شامل Maven wrapper است که ساخت موفقیت‌آمیز را بدون نیاز به نصب خود Maven تضمین می‌کند.

در دایرکتوری که پروژه را دانلود یا کلون کرده‌اید، دستورات زیر را اجرا کنید تا مطمئن شوید پیش‌نیازهای لازم برای اجرای پروژه را دارید.

java --version
./mvnw --version

یا در ویندوز:

java -version
mvnw.cmd --version

پایتون

• دایرکتوری ریشه شامل فایل‌های زیر است:

  • main.py - نقطه ورود برنامه پایتون. پیکربندی سرور مورد نظر خود را در این فایل مشخص کنید، سپس آن را اجرا کنید تا سرور شروع به کار کند.
  • requirements.txt - ماژول‌های پایتون مورد نیاز برای اجرای برنامه وب. این ماژول‌ها را می‌توان به طور خودکار با استفاده از pip install -r requirements.txt نصب کرد.

  • client_secret.json - فایل مخفی کلاینت که از Google Cloud دانلود شده است. توجه داشته باشید که این فایل در آرشیو نمونه وجود ندارد؛ شما باید فایل اعتبارنامه‌های دانلود شده خود را تغییر نام داده و در ریشه هر دایرکتوری کپی کنید.

• config.py - گزینه‌های پیکربندی برای سرور Flask.

• دایرکتوری webapp شامل محتوای برنامه وب است و شامل موارد زیر است:

• دایرکتوری /templates/ شامل قالب‌های Jinja برای صفحات مختلف.

• دایرکتوری /static/ شامل تصاویر، CSS و فایل‌های کمکی جاوا اسکریپت.

• routes.py - متدهای هندلر برای مسیرهای برنامه وب.

• __init__.py - مقداردهنده اولیه برای ماژول webapp . این مقداردهنده، سرور Flask را شروع می‌کند و گزینه‌های پیکربندی تنظیم‌شده در config.py را بارگذاری می‌کند.

• فایل‌های اضافی که در یک مرحله خاص از راهنما مورد نیاز هستند.

نود جی اس

هر مرحله از مراحل پیمایش را می‌توان در زیرپوشه <step> مربوط به خود یافت. هر مرحله شامل موارد زیر است:

• فایل‌های استاتیک مانند جاوا اسکریپت، CSS و تصاویر در پوشه ./<step>/public یافت می‌شوند.
• روترهای اکسپرس در پوشه‌های ./<step>/routes یافت می‌شوند.
• قالب‌های HTML در پوشه‌های ./<step>/views یافت می‌شوند.
• برنامه‌ی سرور ./<step>/app.js است.

جاوا

دایرکتوری پروژه شامل موارد زیر است:

• دایرکتوری src.main شامل کد منبع و پیکربندی برای اجرای موفقیت‌آمیز برنامه است. این دایرکتوری شامل موارد زیر است: + دایرکتوری java.com.addons.spring شامل فایل‌های Application.java و Controller.java است. فایل Application.java مسئول اجرای سرور برنامه است در حالی که فایل Controller.java منطق نقطه پایانی را مدیریت می‌کند. + دایرکتوری resources شامل دایرکتوری templates با فایل‌های HTML و جاوا اسکریپت است. همچنین شامل فایل application.properties است که پورت اجرای سرور، مسیر فایل keystore و مسیر دایرکتوری templates را مشخص می‌کند. این مثال شامل فایل keystore در دایرکتوری resources است. می‌توانید آن را در هر جایی که ترجیح می‌دهید ذخیره کنید، اما مطمئن شوید که فایل application.properties را با مسیر مربوطه به‌روزرسانی می‌کنید.
  • pom.xml شامل اطلاعات لازم برای ساخت پروژه و تعریف وابستگی‌های مورد نیاز است.
  • .gitignore شامل نام فایل‌هایی است که نباید در git آپلود شوند. مطمئن شوید که مسیر keystore خود را در این .gitignore اضافه می‌کنید. در مثال ارائه شده، این secrets/*.p12 است (هدف از keystore در بخش زیر مورد بحث قرار گرفته است). برای راهنمای ۲ و بعد از آن، باید مسیر فایل client_secret.json خود را نیز اضافه کنید تا مطمئن شوید که اسرار خود را در یک مخزن راه دور قرار نمی‌دهید. برای راهنمای ۳ و بعد از آن، باید مسیر فایل پایگاه داده H2 و file datastore factory را اضافه کنید. اطلاعات بیشتر در مورد راه‌اندازی این data storeها را می‌توانید در راهنمای سوم در مورد مدیریت بازدیدهای مکرر بیابید.
  • mvnw و mvnw.cmd به ترتیب فایل‌های اجرایی Maven برای یونیکس و ویندوز هستند. برای مثال، اجرای ./mvnw --version در یونیکس، نسخه Apache Maven را به همراه اطلاعات دیگر نمایش می‌دهد.
  • دایرکتوری .mvn شامل پیکربندی مربوط به Maven wrapper است.

پایتون

اعتبارنامه‌های OAuth

همانطور که قبلاً توضیح داده شد، اعتبارنامه‌های OAuth خود را ایجاد و دانلود کنید. فایل JSON را در دایرکتوری ریشه در کنار فایل راه‌اندازی سرور برنامه خود قرار دهید.

پیکربندی سرور

شما چندین گزینه برای اجرای وب سرور دارید. در انتهای فایل پایتون خود، یکی از موارد زیر را اضافه کنید:

1. localhost ناامن. توجه داشته باشید که این فقط برای آزمایش مستقیم در یک پنجره مرورگر مناسب است؛ دامنه‌های ناامن را نمی‌توان در iframe افزونه Classroom بارگیری کرد.

   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 را برای آرگومان 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 main.py

برای مشاهده برنامه وب خود در مرورگر، روی URL که ظاهر می‌شود کلیک کنید تا از اجرای صحیح آن اطمینان حاصل کنید.

نود جی اس

پیکربندی سرور

برای اجرای سرور از طریق HTTPS، باید یک self-certificate ایجاد کنید که برای اجرای برنامه از طریق HTTPS استفاده شود. این اعتبارنامه‌ها باید با نام‌های sslcert/cert.pem و sslcert/key.pem در پوشه ریشه مخزن ذخیره شوند. ممکن است لازم باشد این کلیدها را به زنجیره کلید سیستم عامل خود اضافه کنید تا مرورگر شما آنها را بپذیرد.

مطمئن شوید که *.pem در فایل .gitignore شما وجود دارد، زیرا نمی‌خواهید این فایل را به git ارسال کنید.

سرور را راه اندازی کنید

شما می‌توانید برنامه را با دستور زیر اجرا کنید و step01 به جای مرحله صحیحی که می‌خواهید به عنوان سرور اجرا شود، قرار دهید (برای مثال، step01 به جای 01-basic-app و step02 به جای 02-sign-in).

npm run step01

یا

npm run step02

این کار سرور وب را در https://localhost:5000 راه‌اندازی می‌کند.

شما می‌توانید سرور را با استفاده Control + C در ترمینال خود خاتمه دهید.

جاوا

پیکربندی سرور

برای اجرای سرور از طریق HTTPS، باید یک گواهی خودساخته ایجاد کنید که برای اجرای برنامه از طریق HTTPS استفاده شود.

استفاده از mkcert را برای توسعه محلی در نظر بگیرید. پس از نصب mkcert ، دستورات زیر یک گواهی ذخیره شده محلی برای اجرا روی HTTPS ایجاد می‌کنند.

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

این مثال شامل فایل keystore در دایرکتوری resources است. شما می‌توانید آن را در هر جایی که ترجیح می‌دهید ذخیره کنید، اما مطمئن شوید که فایل application.properties را با مسیر مربوطه به‌روزرسانی می‌کنید. نام دامنه، دامنه‌ای است که پروژه را روی آن اجرا می‌کنید (برای مثال، localhost ).

مطمئن شوید که *.p12 در فایل .gitignore شما وجود دارد، زیرا نمی‌خواهید این فایل به git ارسال شود.

سرور را راه اندازی کنید

با اجرای متد main در فایل Application.java ، سرور را راه‌اندازی کنید. برای مثال، در IntelliJ، می‌توانید روی Application.java کلیک راست کرده و گزینه Run 'Application' در دایرکتوری src/main/java/com/addons/spring انتخاب کنید یا فایل Application.java را باز کنید تا روی فلش سبز رنگ سمت چپ امضای متد main(String[] args) کلیک کنید. همچنین می‌توانید پروژه را در یک پنجره ترمینال اجرا کنید:

./mvnw spring-boot:run

یا در ویندوز:

mvnw.cmd spring-boot:run

این دستور سرور را در https://localhost:5000 یا در پورتی که در application.properties مشخص کرده‌اید، راه‌اندازی می‌کند.