Tutoriels

Python

Notre exemple Python utilise le framework Flask. Vous pouvez télécharger le code source complet à partir des liens fournis.

Si nécessaire, installez Python 3.7+ et assurez-vous que pip est disponible.

python3 -m ensurepip --upgrade

Nous vous recommandons également de configurer et d'activer un nouvel environnement virtuel Python.

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

Il y a un requirements.txt dans chaque sous-répertoire du tutoriel des exemples téléchargés. Vous pouvez installer rapidement les bibliothèques requises à l'aide de pip. Exécutez les commandes suivantes pour installer les bibliothèques requises pour le premier tutoriel.

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

Node.js

Notre exemple Node.js utilise le framework Express. Vous pouvez télécharger le code source complet à partir des liens fournis.

Cet exemple nécessite Node.js v16.13 ou une version ultérieure.

Installez les modules de nœud requis à l'aide de npm.

npm install

Java

Notre exemple Java utilise le framework Spring Boot. Vous pouvez télécharger le code source complet à partir des liens fournis.

Installez Java 11 ou une version ultérieure si ce n'est pas déjà fait.

Les applications Spring Boot peuvent utiliser Gradle ou Maven pour gérer les compilations et les dépendances. Cet exemple inclut le wrapper Maven qui garantit la réussite de la compilation sans que vous ayez à installer Maven lui-même.

Dans le répertoire dans lequel vous avez téléchargé ou cloné le projet, exécutez les commandes suivantes pour vous assurer que vous disposez des conditions préalables à l'exécution du projet.

java --version
./mvnw --version

Ou sous Windows :

java -version
mvnw.cmd --version

Python

• La racine du répertoire contient les fichiers suivants:

  • main.py : point d'entrée de l'application Python. Spécifiez la configuration de serveur que vous souhaitez utiliser dans ce fichier, puis exécutez-la pour démarrer le serveur.
  • requirements.txt : modules Python requis pour exécuter l'application Web. Ils peuvent être installés automatiquement à l'aide de pip install -r requirements.txt.

  • client_secret.json : fichier du secret du client téléchargé à partir de Google Cloud. Notez que cela n'est pas inclus dans l'exemple d'archive. Vous devez renommer et copier le fichier d'identifiants téléchargé dans la racine de chaque répertoire.

• config.py : options de configuration du serveur Flask.

• Le répertoire webapp comporte le contenu de l'application Web. Elle comprend les éléments suivants :

• Répertoire /templates/ avec des modèles Jinja pour différentes pages.

• Répertoire /static/ contenant les images, CSS et les fichiers JavaScript auxiliaires.

• routes.py : méthodes de gestionnaire pour les routes de l'application Web.

• __init__.py : initialiseur du module webapp. Cet initialiseur démarre le serveur Flask et charge les options de configuration définies dans config.py.

• Fichiers supplémentaires requis par une étape spécifique du tutoriel.

Node.js

Chaque étape de la présentation se trouve dans son propre sous-dossier <step>. Chaque étape contient les éléments suivants:

• Les fichiers statiques tels que JavaScript, CSS et les images se trouvent dans le dossier ./<step>/public.
• Les routeurs Express se trouvent dans les dossiers ./<step>/routes.
• Les modèles HTML se trouvent dans les dossiers ./<step>/views.
• L'application de serveur est ./<step>/app.js.

Java

Le répertoire du projet comprend les éléments suivants:

• Le répertoire src.main contient le code source et la configuration nécessaires pour exécuter l'application. Ce répertoire comprend les éléments suivants : + Le répertoire java.com.addons.spring contient les fichiers Application.java et Controller.java. Le fichier Application.java est responsable de l'exécution du serveur d'applications, tandis que le fichier Controller.java gère la logique du point de terminaison. + Le répertoire resources contient le répertoire templates avec les fichiers HTML et JavaScript. Il contient également le fichier application.properties qui spécifie le port d'exécution du serveur, ainsi que les chemins d'accès au fichier keystore et au répertoire templates. Cet exemple inclut le fichier keystore dans le répertoire resources. Vous pouvez le stocker où vous le souhaitez, mais veillez à mettre à jour le fichier application.properties avec le chemin d'accès en conséquence.
  • pom.xml contient les informations nécessaires pour créer le projet et définir les dépendances requises.
  • .gitignore contient des noms de fichiers qui ne doivent pas être importés dans Git. Veillez à ajouter le chemin d'accès à votre keystore dans ce .gitignore. Dans l'exemple fourni, il s'agit de secrets/*.p12 (la finalité du keystore est décrite dans la section ci-dessous). Pour le tutoriel 2 et les suivants, vous devez également inclure le chemin d'accès à votre fichier client_secret.json pour vous assurer de ne pas inclure vos secrets dans un dépôt distant. Pour le tutoriel 3 et les suivants, vous devez ajouter le chemin d'accès au fichier de base de données H2 et à la fabrique de fichiers Datastore. Pour en savoir plus sur la configuration de ces data stores, consultez le troisième tutoriel sur la gestion des visites répétées.
  • mvnw et mvnw.cmd sont les exécutables du wrapper Maven pour Unix et Windows, respectivement. Par exemple, l'exécution de ./mvnw --version sur Unix génère la version d'Apache Maven, entre autres informations.
  • Le répertoire .mvn contient la configuration du wrapper Maven.

Python

Identifiants OAuth

Créez et téléchargez vos identifiants OAuth comme décrit précédemment. Placez le fichier JSON dans le répertoire racine avec le fichier de lancement du serveur de votre application.

Configurer le serveur

Vous disposez de plusieurs options pour exécuter le serveur Web. À la fin de votre fichier Python, ajoutez l'un des éléments suivants:

1. localhost non sécurisé. Notez que cette option convient uniquement aux tests dans une fenêtre de navigateur. Les domaines non sécurisés ne peuvent pas être chargés dans l'iFrame du module complémentaire 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. Sécurisez localhost. Vous devez spécifier un tuple de fichiers de clé SSL pour l'argument 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. Cela convient à un serveur prêt pour la production ou à un déploiement cloud. Nous vous recommandons de définir une variable d'environnement PORT pour cette option de lancement.

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

Lancer le serveur

Exécutez votre application Python pour lancer le serveur tel que configuré à l'étape précédente.

python main.py

Cliquez sur l'URL qui s'affiche pour afficher votre application Web dans un navigateur afin de vérifier qu'elle fonctionne correctement.

Node.js

Configurer le serveur

Pour exécuter le serveur via HTTPS, vous devez créer un autocertificat permettant d'exécuter l'application via HTTPS. Ces identifiants doivent être enregistrés sous les noms sslcert/cert.pem et sslcert/key.pem dans le dossier racine du dépôt. Vous devrez peut-être ajouter ces clés à la chaîne de clés de votre système d'exploitation pour que votre navigateur les accepte.

Assurez-vous que *.pem se trouve dans le fichier .gitignore, car vous ne souhaitez pas valider le fichier sur Git.

Lancer le serveur

Vous pouvez exécuter l'application à l'aide de la commande suivante, en remplaçant step01 par l'étape que vous souhaitez exécuter en tant que serveur (par exemple, step01 pour 01-basic-app et step02 pour 02-sign-in).

npm run step01

ou

npm run step02

Le serveur Web est alors lancé à l'adresse https://localhost:5000.

Vous pouvez arrêter le serveur avec Control + C dans votre terminal.

Java

Configurer le serveur

Pour exécuter le serveur via HTTPS, vous devez créer un autocertificat permettant d'exécuter l'application via HTTPS.

Envisagez d'utiliser mkcert pour le développement local. Une fois que vous avez installé mkcert, les commandes suivantes génèrent un certificat stocké localement à exécuter via HTTPS.

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

Cet exemple inclut le fichier keystore dans le répertoire de ressources. Vous pouvez le stocker où vous le souhaitez, mais veillez à mettre à jour le fichier application.properties avec le chemin d'accès en conséquence. Le nom de domaine est le domaine sur lequel vous exécutez le projet (par exemple, localhost).

Assurez-vous que *.p12 se trouve dans le fichier .gitignore, car vous ne souhaitez pas valider le fichier sur Git.

Lancer le serveur

Lancez le serveur en exécutant la méthode main dans le fichier Application.java. Dans IntelliJ, par exemple, vous pouvez effectuer un clic droit sur Application.java > Run 'Application' dans le répertoire src/main/java/com/addons/spring ou ouvrir le fichier Application.java pour cliquer sur la flèche verte située à gauche de la signature de la méthode main(String[] args). Vous pouvez également exécuter le projet dans une fenêtre de terminal:

./mvnw spring-boot:run

Ou sous Windows :

mvnw.cmd spring-boot:run

Le serveur est alors lancé à l'adresse https://localhost:5000 ou sur le port que vous avez spécifié dans application.properties.