Trabalhando localmente

O Code Hub pode ser utilizado inteiramente a partir da linha de comando, usando a CLI, caso você prefira usar suas próprias ferramentas para trabalhar localmente.

Para implantar uma aplicação diretamente do navegador, sem o uso de ferramentas locais, consulte nosso guia sobre trabalhar na nuvem.

Instalação da CLI

O Code Hub pode ser utilizado inteiramente a partir da linha de comando; vcr é a interface de linha de comando necessária para gerenciar e implantar suas aplicações a partir do terminal.

pwsh -Command "iwr https://raw.githubusercontent.com/Vonage/cloud-runtime-cli/main/script/install.ps1 -useb | iex"

Configurar a CLI

Configure sua conta usando este comando:

vcr configure

O comando solicitará que você indique uma região padrão, bem como sua chave e seu segredo da API da Vonage, que você pode obter no Painel da API.

Arquivo de configuração da CLI

vcr configure grava suas credenciais e preferências em ~/.vcr-cli. Você também pode editar esse arquivo diretamente. O arquivo está no formato INI:

[default]
graphql_endpoint = https://api-eu.vonage.com/v1/vcr/euw1/api/graphql/v1/graphql
default_region = aws.euw1

[credentials]
apikey = YOUR_API_KEY
apisecret = YOUR_API_SECRET

O graphql_endpoint para cada região é:

Região Ponto final
UE Oeste (aws.euw1) https://api-eu.vonage.com/v1/vcr/euw1/api/graphql/v1/graphql
Leste dos EUA (aws.use1) https://api-us.vonage.com/v1/vcr/use1/api/graphql/v1/graphql
AP Sudeste (aws.apse1) https://api-ap.vonage.com/v1/vcr/apse1/api/graphql/v1/graphql
AP Sudeste de Sydney (aws.apse2) https://api-ap.vonage.com/v1/vcr/apse2/api/graphql/v1/graphql

Atualização da CLI

Para atualizar a CLI, execute:

vcr upgrade

Isso exibirá a versão atual da CLI que você tem instalada. Se houver uma versão mais recente disponível, será solicitado que você a instale.

NOTA: Talvez seja necessário executar o comando usando sudo para conceder permissões à CLI do Cloud Runtime para mover a nova versão da CLI para a pasta de instalação. Você também pode realizar essa transferência por conta própria.

Usando a CLI

Para inicializar um projeto, execute o comando a seguir para começar a inserir seus dados:

vcr init

Ao executar o comando, serão solicitadas as seguintes informações:

  • Nome do projeto: um nome para o seu projeto.
  • Nome da instância: Digite um nome para a instância que será criada. É possível ter várias instâncias para um único projeto, portanto, esse nome deve ser fácil de lembrar.
  • Tempo de execução: Selecione o ambiente de execução que você deseja usar quando o código for executado.
  • Região: Selecione a região na qual deseja que sua instância seja executada.
  • ID do aplicativo para a instância: Para utilizar as APIs da Vonage, é necessário ter um aplicativo. Selecione o ID do aplicativo que você deseja utilizar; caso ainda não tenha criado um, você pode pular esta etapa e inserir o ID posteriormente. Para criar um aplicativo, acesse o Página de Applications no painel do Vonage ou execute vcr app create. Ao implantar sua instância, o Cloud Runtime configurará automaticamente os webhooks em seu aplicativo para você.
  • ID do aplicativo para depuração: Você pode fornecer um ID de aplicativo separado para ser usado exclusivamente para depuração, o que significa que sua instância implantada, bem como o aplicativo e os webhooks correspondentes, não serão afetados pela depuração local.
  • Modelo: Escolha um modelo da lista para visualizar um projeto existente. A lista completa de modelos pode ser encontrada no Code Hub

Depois de inserir todas as informações necessárias, um vcr.yml Será criado um arquivo de configuração, no qual você poderá adicionar tudo o que tiver deixado de fora ou editar qualquer um dos detalhes que acabou de fornecer. Se você tiver selecionado um modelo, os arquivos necessários para executar essa aplicação também serão baixados. Agora você pode abrir esses arquivos em seu ambiente local para começar a visualizar e editar o projeto.

Próximos passos

Ao trabalhar no seu projeto, os recursos a seguir podem ser úteis:

  • Depuração: Depure seu código localmente como se ele estivesse implantado na plataforma.
  • Implantação: Quando seu projeto estiver pronto, crie rapidamente uma instância em execução na plataforma por meio da implantação.

Gerenciamento de Applications

É possível gerenciar as Applications da Vonage pela CLI usando o vcr app comandos.

Para criar um novo aplicativo:

vcr app create --voice --messages

Para regenerar a chave privada e a chave pública de uma aplicação existente:

vcr app generate-keys --app-id YOUR_APPLICATION_ID

Isso substitui o par de chaves existente do aplicativo. A nova chave privada será baixada e você precisará atualizar todas as referências a ela em seu projeto ou em seus segredos.