Panduan

Python

Contoh Python kami menggunakan framework Flask. Anda dapat mendownload kode sumber lengkap dari link yang disediakan.

Jika perlu, instal Python 3.7+ dan pastikan pip tersedia.

python3 -m ensurepip --upgrade

Sebaiknya Anda juga menyiapkan dan mengaktifkan lingkungan virtual Python baru.

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

Ada requirements.txt di setiap subdirektori panduan dalam contoh yang didownload. Anda dapat menginstal library yang diperlukan dengan cepat menggunakan pip. Gunakan perintah berikut untuk menginstal library yang diperlukan untuk panduan pertama.

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

Node.js

Contoh Node.js kami menggunakan framework Express. Anda dapat mendownload kode sumber lengkap dari link yang disediakan.

Contoh ini memerlukan Node.js v16.13 atau yang lebih baru.

Instal modul node yang diperlukan menggunakan npm.

npm install

Java

Contoh Java kami menggunakan framework Spring Boot. Anda dapat mendownload kode sumber lengkap dari link yang disediakan.

Instal Java 11+ jika Anda belum menginstalnya di komputer.

Aplikasi Spring Boot dapat menggunakan Gradle atau Maven untuk menangani build dan mengelola dependensi. Contoh ini menyertakan wrapper Maven yang memastikan build berhasil tanpa mengharuskan Anda menginstal Maven itu sendiri.

Di direktori tempat Anda mendownload atau meng-clone project, jalankan perintah berikut untuk memastikan Anda memiliki prasyarat untuk menjalankan project.

java --version
./mvnw --version

Atau di Windows:

java -version
mvnw.cmd --version

Python

• Root direktori berisi file berikut:

  • main.py - titik entri aplikasi Python. Tentukan konfigurasi server yang ingin Anda gunakan dalam file ini, lalu jalankan untuk memulai server.
  • requirements.txt - modul Python yang diperlukan untuk menjalankan aplikasi web. Modul ini dapat diinstal secara otomatis menggunakan pip install -r requirements.txt.

  • client_secret.json - file secret klien yang didownload dari Google Cloud. Perhatikan bahwa file ini tidak disertakan dalam contoh arsip; Anda harus mengganti nama dan menyalin file kredensial yang didownload ke setiap root direktori.

• config.py - opsi konfigurasi untuk server Flask.

• Direktori webapp berisi konten untuk aplikasi web. Paket ini mencakup:

• Direktori /templates/ dengan template Jinja untuk berbagai halaman.

• Direktori /static/ dengan gambar, CSS, dan file JavaScript tambahan.

• routes.py - metode pengendali untuk rute aplikasi web.

• __init__.py - penginisialisasi untuk modul webapp. Penginisialisasi ini memulai server Flask dan memuat opsi konfigurasi yang ditetapkan di config.py.

• File tambahan yang diperlukan oleh langkah panduan tertentu.

Node.js

Setiap langkah panduan dapat ditemukan di subfolder <step> sendiri. Setiap langkah berisi:

• File statis seperti JavaScript, CSS, dan gambar ditemukan di folder ./<step>/public.
• Router ekspres ditemukan di folder ./<step>/routes.
• Template HTML ditemukan di folder ./<step>/views.
• Aplikasi server adalah ./<step>/app.js.

Java

Direktori project mencakup hal berikut:

• Direktori src.main berisi kode sumber dan konfigurasi untuk menjalankan aplikasi dengan sukses. Direktori ini mencakup hal berikut: + Direktori java.com.addons.spring berisi file Application.java dan Controller.java. File Application.java bertanggung jawab untuk menjalankan server aplikasi, sedangkan file Controller.java menangani logika endpoint. + Direktori resources berisi direktori templates dengan file HTML dan JavaScript. File ini juga berisi file application.properties yang menentukan port untuk menjalankan server, jalur ke file keystore, dan jalur ke direktori templates. Contoh ini menyertakan file keystore di direktori resources. Anda dapat menyimpannya di mana saja, tetapi pastikan Anda memperbarui file application.properties dengan jalur yang sesuai.
  • pom.xml berisi informasi yang diperlukan untuk mem-build project dan menentukan dependensi yang diperlukan.
  • .gitignore berisi nama file yang tidak boleh diupload ke git. Pastikan Anda menambahkan jalur ke keystore di .gitignore ini. Dalam contoh yang diberikan, ini adalah secrets/*.p12 (tujuan keystore dibahas di bagian bawah). Untuk panduan 2 dan seterusnya, Anda juga harus menyertakan jalur ke file client_secret.json untuk memastikan bahwa Anda tidak menyertakan rahasia di repositori jarak jauh. Untuk panduan 3 dan seterusnya, Anda harus menambahkan jalur ke file database H2 dan factory datastore file. Informasi selengkapnya tentang penyiapan penyimpanan data ini dapat ditemukan di panduan ketiga tentang menangani kunjungan berulang.
  • mvnw dan mvnw.cmd adalah file yang dapat dieksekusi wrapper Maven untuk Unix dan Windows. Misalnya, menjalankan ./mvnw --version di Unix akan menghasilkan versi Apache Maven, di antara informasi lainnya.
  • Direktori .mvn berisi konfigurasi untuk wrapper Maven.

Python

Kredensial OAuth

Buat dan download kredensial OAuth Anda seperti yang dijelaskan sebelumnya. Tempatkan file JSON di direktori root bersama file peluncuran server aplikasi Anda.

Mengonfigurasi server

Anda memiliki beberapa opsi untuk menjalankan server web. Di akhir file Python, tambahkan salah satu dari berikut:

1. localhost tidak aman. Perhatikan bahwa ini hanya cocok untuk pengujian langsung di jendela browser; domain yang tidak aman tidak dapat dimuat di iframe add-on 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. Amankan localhost. Anda harus menentukan tuple file kunci SSL untuk argumen 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. Server Gunicorn. Hal ini cocok untuk deployment cloud atau server yang siap produksi. Sebaiknya tetapkan variabel lingkungan PORT untuk digunakan dengan opsi peluncuran ini.

   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")
   

Meluncurkan server

Jalankan aplikasi Python untuk meluncurkan server seperti yang dikonfigurasi di langkah sebelumnya.

python main.py

Klik URL yang muncul untuk melihat aplikasi web Anda di browser guna mengonfirmasi bahwa aplikasi tersebut berjalan dengan benar.

Node.js

Mengonfigurasi server

Untuk menjalankan server melalui HTTPS, Anda perlu membuat sertifikat mandiri yang digunakan untuk menjalankan aplikasi melalui HTTPS. Kredensial ini harus disimpan sebagai sslcert/cert.pem dan sslcert/key.pem di folder root repositori. Anda mungkin perlu menambahkan kunci ini ke key chain OS agar browser dapat menerimanya.

Pastikan *.pem ada dalam file .gitignore karena Anda tidak ingin melakukan commit file ke git.

Meluncurkan server

Anda dapat menjalankan aplikasi dengan perintah berikut yang mengganti step01 untuk langkah yang benar yang ingin Anda jalankan sebagai server (misalnya, step01 untuk 01-basic-app dan step02 untuk 02-sign-in).

npm run step01

atau

npm run step02

Tindakan ini akan meluncurkan server web di https://localhost:5000.

Anda dapat menghentikan server dengan Control + C di terminal.

Java

Mengonfigurasi server

Untuk menjalankan server melalui HTTPS, Anda perlu membuat sertifikat mandiri yang digunakan untuk menjalankan aplikasi melalui HTTPS.

Pertimbangkan untuk menggunakan mkcert untuk pengembangan lokal. Setelah Anda menginstal mkcert, perintah berikut akan membuat sertifikat yang disimpan secara lokal untuk dijalankan melalui HTTPS.

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

Contoh ini menyertakan file keystore di direktori resource. Anda dapat menyimpan file tersebut di mana saja, tetapi pastikan Anda memperbarui file application.properties dengan jalur yang sesuai. Nama domain adalah domain tempat Anda menjalankan project (misalnya, localhost).

Pastikan *.p12 ada dalam file .gitignore karena Anda tidak ingin melakukan commit file ke git.

Meluncurkan server

Luncurkan server dengan menjalankan metode main dalam file Application.java. Di IntelliJ, misalnya, Anda dapat mengklik kanan Application.java > Run 'Application' di direktori src/main/java/com/addons/spring atau membuka file Application.java untuk mengklik panah hijau di sebelah kiri tanda tangan metode main(String[] args). Atau, Anda dapat menjalankan project di jendela terminal:

./mvnw spring-boot:run

atau di Windows:

mvnw.cmd spring-boot:run

Tindakan ini akan meluncurkan server di https://localhost:5000 atau di port yang Anda tentukan di application.properties.