Tutoriais

Python

Nosso exemplo de Python usa o framework Flask. Você pode fazer o download de todo o código-fonte nos links fornecidos.

Se necessário, instale o Python 3.7+ e verifique se pip está disponível.

python3 -m ensurepip --upgrade

Também recomendamos que você configure e ative um novo ambiente virtual do Python.

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

Há um requirements.txt em cada subdiretório de tutorial nos exemplos transferidos por download. É possível instalar rapidamente as bibliotecas necessárias usando pip. Use os comandos abaixo para instalar as bibliotecas necessárias para o primeiro tutorial.

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

Node.js

Nosso exemplo do Node.js usa o framework Express (em inglês). Você pode fazer o download do código-fonte completo nos links fornecidos.

Este exemplo requer o Node.js v16.13 ou versões mais recentes.

Instale os módulos de nó necessários usando npm.

npm install

Java

Nosso exemplo do Java usa o framework Spring Boot. Você pode fazer o download do código-fonte completo nos links fornecidos.

Instale o Java 11+ se ainda não tiver feito isso na sua máquina.

Os aplicativos do Spring Boot podem usar o Gradle ou Maven para processar builds e gerenciar dependências. Esse exemplo inclui o wrapper do Maven que garante um build bem-sucedido sem exigir a instalação do próprio Maven.

No diretório em que você fez o download ou clonou o projeto, execute os comandos a seguir para garantir que você tenha os pré-requisitos para executar o projeto.

java --version
./mvnw --version

Ou no Windows:

java -version
mvnw.cmd --version

Python

• A raiz do diretório contém os seguintes arquivos:

  • main.py: o ponto de entrada do aplicativo Python. Especifique a configuração do servidor que você quer usar nesse arquivo e execute-a para iniciar o servidor.
  • requirements.txt: os módulos Python necessários para executar o app da Web. Eles podem ser instalados automaticamente usando pip install -r requirements.txt.

  • client_secret.json: o arquivo de chave secreta do cliente baixado do Google Cloud. Observe que isso não está incluído no arquivo de exemplo. Renomeie e copie o arquivo de credenciais salvo em cada raiz de diretório.

• config.py: opções de configuração do servidor Flask.

• O diretório webapp tem o conteúdo do aplicativo da Web. Inclui o seguinte:

• O diretório /templates/ com modelos Jinja para várias páginas.

• O diretório /static/ com imagens, CSS e arquivos JavaScript complementares.

• routes.py: os métodos do gerenciador para as rotas do aplicativo da Web.

• __init__.py: o inicializador do módulo webapp. Esse inicializador inicia o servidor Flask e carrega as opções de configuração definidas em config.py.

• Arquivos adicionais conforme exigido por uma etapa específica do tutorial.

Node.js

Cada etapa do passo a passo pode ser encontrada na própria subpasta <step>. Cada etapa contém:

• Arquivos estáticos, como JavaScript, CSS e imagens, são encontrados na pasta ./<step>/public.
• Os roteadores expressos ficam nas pastas ./<step>/routes.
• Os modelos HTML são encontrados nas pastas ./<step>/views.
• O aplicativo de servidor é ./<step>/app.js.

Java

O diretório do projeto inclui o seguinte:

• O diretório src.main contém o código-fonte e a configuração para executar o aplicativo com êxito. Esse diretório inclui o seguinte: + O diretório java.com.addons.spring contém os arquivos Application.java e Controller.java. O arquivo Application.java é responsável por executar o servidor de aplicativos, enquanto o arquivo Controller.java processa a lógica do endpoint. + O diretório resources contém o diretório templates com arquivos HTML e JavaScript. Ele também contém o arquivo application.properties, que especifica a porta para executar o servidor, o caminho para o arquivo de keystore e o caminho para o diretório templates. Esse exemplo inclui o arquivo de keystore no diretório resources. Você pode armazená-lo onde preferir, mas atualize o arquivo application.properties com o caminho adequado.
  • pom.xml contém as informações necessárias para criar o projeto e definir as dependências necessárias.
  • .gitignore contém nomes de arquivos que não devem ser enviados ao git. Adicione o caminho para seu keystore nesse .gitignore. No exemplo fornecido, é secrets/*.p12. O objetivo do keystore é discutido na seção abaixo. No tutorial 2 e posteriores, inclua também o caminho para o arquivo client_secret.json para garantir que os secrets não sejam incluídos em um repositório remoto. Para o tutorial 3 e mais recentes, você precisa adicionar o caminho para o arquivo do banco de dados H2 e a fábrica do repositório de dados de arquivos. Mais informações sobre a configuração desses repositórios de dados podem ser encontradas no terceiro tutorial sobre como gerenciar visitas repetidas.
  • mvnw e mvnw.cmd são os executáveis do wrapper Maven para Unix e Windows, respectivamente. Por exemplo, executar ./mvnw --version em Unix gera a versão do Apache Maven, entre outras informações.
  • O diretório .mvn contém a configuração do wrapper do Maven.

Python

Credenciais do OAuth

Crie e faça o download das credenciais do OAuth, conforme descrito anteriormente. Coloque o arquivo JSON no diretório raiz ao lado do arquivo de inicialização do servidor do aplicativo.

Configurar o servidor

Há várias opções para executar o servidor da Web. No final do arquivo Python, adicione uma das seguintes opções:

1. localhost desprotegida. Isso é adequado para testes diretos apenas em uma janela do navegador. Domínios não seguros não podem ser carregados no iframe de complementos do Google Sala de Aula.

   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. Proteja o localhost. É necessário especificar uma tupla de arquivos de chave SSL para o argumento 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 (link em inglês). Isso é adequado para um servidor pronto para produção ou implantação em nuvem. Recomendamos definir uma variável de ambiente PORT para usar com essa opção de inicialização.

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

Iniciar o servidor

Execute o aplicativo Python para iniciar o servidor conforme configurado na etapa anterior.

python main.py

Clique no URL que aparece para visualizar seu app da Web em um navegador para confirmar se ele está sendo executado corretamente.

Node.js

Configurar o servidor

Para executar o servidor por HTTPS, é necessário criar um autocertificado usado para executar o aplicativo por HTTPS. Essas credenciais precisam ser salvas como sslcert/cert.pem e sslcert/key.pem na pasta raiz do repositório. Talvez seja necessário adicionar essas chaves à cadeia de chaves do SO para que o navegador as aceite.

Verifique se *.pem está no seu arquivo .gitignore, porque você não quer confirmar o arquivo no git.

Iniciar o servidor

É possível executar o aplicativo com o comando a seguir, substituindo step01 pela etapa correta que você quer executar como servidor (por exemplo, step01 para 01-basic-app e step02 para 02-login).

npm run step01

ou

npm run step02

Isso inicia o servidor da Web em https://localhost:5000.

É possível encerrar o servidor com Control + C no seu terminal.

Java

Configurar o servidor

Para executar o servidor por HTTPS, é necessário criar um autocertificado usado para executar o aplicativo por HTTPS.

Considere usar o mkcert para desenvolvimento local. Depois de instalar o mkcert, os comandos a seguir geram um certificado armazenado localmente para ser executado por HTTPS.

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

Este exemplo inclui o arquivo de keystore no diretório de recursos. É possível armazenar o arquivo como preferir, mas atualize o arquivo application.properties com o caminho adequado. O nome de domínio é o domínio em que você executa o projeto (por exemplo, localhost).

Verifique se *.p12 está no seu arquivo .gitignore, porque você não quer confirmar o arquivo no git.

Iniciar o servidor

Inicie o servidor executando o método main no arquivo Application.java. No IntelliJ, por exemplo, você pode clicar com o botão direito do mouse em Application.java > Run 'Application' no diretório src/main/java/com/addons/spring ou abrir o arquivo Application.java para clicar na seta verde à esquerda da assinatura do método main(String[] args). Como alternativa, execute o projeto em uma janela de terminal:

./mvnw spring-boot:run

ou no Windows:

mvnw.cmd spring-boot:run

Isso inicia o servidor em https://localhost:5000 ou na porta especificada em application.properties.