Procedure dettagliate

Python

Il nostro esempio Python utilizza il framework Flask. Puoi scaricare codice sorgente completo dai link forniti.

Se necessario, installa Python 3.7 o versioni successive e assicurati che pip sia disponibile.

python3 -m ensurepip --upgrade

Ti consigliamo inoltre di configurare e attivare una nuova completamente gestito di Google Cloud.

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

È presente un requirements.txt in ogni sottodirectory della procedura dettagliata nella esempi scaricati. Puoi installare rapidamente le librerie necessarie utilizzando pip. Usa i comandi seguenti per installare le librerie richieste per la prima procedura dettagliata.

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

Node.js

Il nostro esempio di Node.js utilizza il framework Express. Puoi scaricare Il codice sorgente completo dai link forniti.

Questo esempio richiede Node.js v16.13 o versioni successive.

Installa i moduli di nodo richiesti utilizzando npm.

npm install

Java

Il nostro esempio Java utilizza il framework Spring Boot. Puoi scaricare Il codice sorgente completo dai link forniti.

Installa Java 11+ se non è già installato sulla macchina.

Le applicazioni Spring Boot possono utilizzare Gradle o Maven per gestire le build e delle dipendenze. Questo esempio include il wrapper Maven che garantisce una build riuscita senza la necessità di installare Maven.

Nella directory in cui hai scaricato o clonato il progetto, esegui seguenti per assicurarti di disporre dei prerequisiti per eseguire il progetto.

java --version
./mvnw --version

Su Windows:

java -version
mvnw.cmd --version

Python

• La directory root contiene i seguenti file:

  • main.py: il punto di ingresso dell'applicazione Python. Specifica il server configurazione che vuoi utilizzare in questo file, quindi eseguilo avviare il server.
  • requirements.txt: i moduli Python necessari per eseguire l'app web. Possono essere installati automaticamente utilizzando pip install -r requirements.txt.

  • client_secret.json: il file del client secret scaricato da Google Google Cloud. Tieni presente che non è incluso nell'archivio di esempio. tu rinomina e copia il file delle credenziali scaricato della directory radice.

• config.py: opzioni di configurazione per il server Flask.

• La directory webapp include i contenuti dell'applicazione web. Include i seguenti contenuti:

• La directory /templates/ con i modelli Jinja per varie pagine.

• La directory /static/ con immagini, CSS e JavaScript aggiuntivo .

• routes.py: i metodi dei gestori per le route dell'applicazione web.

• __init__.py: l'inizializzatore del modulo webapp. Questo l'inizializzatore avvia il server Flask e carica le opzioni di configurazione impostato in config.py.

• File aggiuntivi come richiesto da un determinato passaggio della procedura dettagliata.

Node.js

Ogni passaggio della procedura dettagliata può essere individuato in <step> sottocartella. Ogni passaggio contiene:

• I file statici come JavaScript, CSS e immagini si trovano nella ./<step>/public cartella.
• I router Express si trovano nelle cartelle ./<step>/routes.
• I modelli HTML sono disponibili nelle cartelle ./<step>/views.
• L'applicazione server è ./<step>/app.js.

Java

La directory del progetto include quanto segue:

• La directory src.main contiene il codice sorgente e la configurazione da eseguire correttamente l'applicazione. Questa directory include: + java.com.addons.spring directory contiene Application.java e Controller.java file. La Il file Application.java è responsabile dell'esecuzione server delle applicazioni, mentre il file Controller.java gestisce dalla logica dell'endpoint. + resources la directory contiene la directory templates con HTML e JavaScript. Contiene anche application.properties che specifica la porta su cui eseguire il server, il percorso del file dell'archivio chiavi e il percorso Directory templates. Questo esempio include il file dell'archivio chiavi nella directory resources. Puoi archiviarlo dove vuoi preferisci, ma aggiorna application.properties con il percorso corrispondente.
  • pom.xml contiene le informazioni necessarie per creare il progetto e e definire le dipendenze richieste.
  • .gitignore contiene nomi di file che non devono essere caricati su Git. Assicurati di aggiungere il percorso all'archivio chiavi in questo campo .gitignore. Nell'esempio fornito, questo è secrets/*.p12 (lo scopo del l'archivio chiavi è discusso nella sezione di seguito). Per la procedura dettagliata 2 e oltre, devi includere anche il percorso client_secret.json per assicurarti di non includere i tuoi i secret in un repository remoto. Per la procedura dettagliata 3 e oltre, deve aggiungere il percorso al datastore del file e del database H2 fabbrica. Per ulteriori informazioni sull'impostazione di questi datastore, che trovi nella terza procedura dettagliata sulla gestione di visite ripetute.
  • mvnw e mvnw.cmd sono gli eseguibili del wrapper Maven per Unix e Windows. Ad esempio, l'esecuzione di ./mvnw --version su Unix restituisce la versione di Apache Maven, tra le altre informazioni.
  • La directory .mvn contiene la configurazione del wrapper Maven.

Python

Credenziali OAuth

Crea e scarica le tue credenziali OAuth come descritto in precedenza. Luogo il file JSON nella directory radice accanto al server dell'applicazione avviare il file.

Configura il server

Sono disponibili diverse opzioni per l'esecuzione del server web. Alla fine Python, aggiungi uno dei seguenti elementi:

1. localhost non protetto. È adatto per i test diretti solo in una finestra del browser; i domini non sicuri non possono essere caricati nella L'iframe del componente aggiuntivo di 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. Proteggi localhost. Devi specificare una tupla di file di chiavi SSL per ssl_context argomento.

   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. È adatto a un server pronto per la produzione deployment nel cloud. Ti consigliamo di impostare una variabile di ambiente PORT per da utilizzare con questa opzione di avvio.

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

Avvia il server

Esegui l'applicazione Python per avviare il server come configurato nell' passaggio precedente.

python main.py

Fai clic sull'URL visualizzato per visualizzare la tua app web in un browser e verificare che funzioni correttamente.

Node.js

Configura il server

Per eseguire il server tramite HTTPS, devi creare un auto-certificato utilizzato per eseguire l'applicazione su HTTPS. Le credenziali devono essere salvato come sslcert/cert.pem e sslcert/key.pem nella radice del repository . Potrebbe essere necessario aggiungere queste chiavi al portachiavi del sistema operativo per browser per accettarli.

Assicurati che *.pem sia nel file .gitignore perché non vuoi per eseguire il commit del file in git.

Avvia il server

Puoi eseguire l'applicazione con il seguente comando, sostituendo step01 il passaggio corretto che vuoi eseguire come server (ad esempio, step01 per 01-basic-app e step02 per 02-sign-in).

npm run step01

o

npm run step02

Viene avviato il server web all'indirizzo https://localhost:5000.

Puoi terminare il server con Control + C nel tuo terminale.

Java

Configura il server

Per eseguire il server tramite HTTPS, devi creare un auto-certificato utilizzato per eseguire l'applicazione su HTTPS.

Potresti usare mkcert per lo sviluppo locale. Dopo aver installato mkcert, i comandi seguenti generano un certificato archiviato localmente da eseguire HTTPS.

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

Questo esempio include il file dell'archivio chiavi nella directory delle risorse. Puoi archivialo dove preferisci, ma assicurati di aggiornare il application.properties con il percorso corrispondente. Il nome di dominio è il dominio su cui esegui il progetto (ad esempio, localhost).

Assicurati che *.p12 sia nel file .gitignore perché non vuoi per eseguire il commit del file in git.

Avvia il server

Avvia il server eseguendo il metodo main in Application.java . In IntelliJ, ad esempio, puoi fare clic con il tasto destro del mouse Application.java > Run 'Application' nel src/main/java/com/addons/spring o apri la directory Application.java per fare clic sulla freccia verde a sinistra di main(String[] args) la firma del metodo. In alternativa, puoi eseguire il progetto in un terminale finestra:

./mvnw spring-boot:run

o su Windows:

mvnw.cmd spring-boot:run

Il server viene avviato all'indirizzo https://localhost:5000 o alla porta specificato in application.properties.