Skip to main content

Guia de início rápido do GitHub Codespaces

Experimente o GitHub Codespaces em 5 minutos.

Introdução

Neste guia, você vai criar um codespace por meio de um repositório de modelos e explorar alguns dos recursos essenciais disponíveis no codespace. Você trabalhará na versão do navegador do Visual Studio Code, que inicialmente é o editor padrão do GitHub Codespaces. Depois de experimentar este guia de início rápido, você poderá usar os Codespaces em outros editores e alterar o editor padrão. Os links são fornecidos no final deste guia.

Neste guia de início rápido, você aprenderá a criar um codespace, se conectar a uma porta encaminhada para ver o aplicativo em execução, publicar o codespace em um novo repositório e personalizar a configuração com extensões.

Para obter mais informações sobre como o GitHub Codespaces funciona exatamente, confira o guia complementar "Aprofundamento no GitHub Codespaces".

Criando seu codespace

  1. Navegue até o repositório de modelos github/haikus-for-codespaces.

  2. Acima da lista de arquivos, clique em Usar este modelo e selecione Abrir em um codespace.

    Usar este botão de modelo

Executando o aplicativo

Após a criação do codespace, o repositório de modelos será clonado nele automaticamente. Agora você pode executar o aplicativo e iniciá-lo em um navegador.

  1. Quando o terminal ficar disponível, insira o comando npm run dev. Esse exemplo usa um projeto Node.js e esse comando executa o script rotulado como "dev" no arquivo package.json, que inicia o aplicativo Web definido no repositório de exemplo.

    npm run dev no terminal

    Se você estiver acompanhando com um tipo diferente de aplicativo, digite o comando inicial correspondente para esse projeto.

  2. Quando o aplicativo for iniciado, o codespace reconhecerá a porta na qual o aplicativo está sendo executado e exibirá um prompt para informar você de que ela foi encaminhada.

    Notificação do sistema de encaminhamento de porta

  3. Clique em Abrir no Navegador para ver seu aplicativo em execução em uma nova guia.

Edite o aplicativo e veja as alterações

  1. Volte ao codespace e abra o arquivo haikus.json clicando duas vezes nele no Gerenciador.

  2. Edite o campo text do primeiro haiku para personalizar o aplicativo com seu haiku.

  3. Volte à aba do aplicativo em execução no seu navegador e atualize para visualizar as suas alterações.

    Se você fechou a guia, abra o painel Portas e clique no ícone Abrir no navegador da porta em execução.

    Painel Encaminhamento de Porta

Enviando e fazendo push das suas alterações

Agora que você fez algumas alterações, use o terminal integrado ou a exibição de origem para publicar o trabalho em um novo repositório.

  1. Na Barra de Atividades, clique na exibição Controle do Código-Fonte. Exibição Controle do Código-Fonte

  2. Para preparar as alterações, clique em + ao lado do arquivo haikus.json ou ao lado de Alterações se tiver alterado vários arquivos e quiser preparar todos eles.

    Barra lateral do controle do código-fonte com o botão de preparo realçado

  3. Para fazer commit das alterações preparadas, digite uma mensagem de commit descrevendo a alteração que você fez e clique em Fazer commit.

    Barra lateral do controle do código-fonte com uma mensagem de commit

  4. Clique em Publicar Branch.

    Captura de tela do botão "Publicar Branch" no VS Code

  5. Na lista suspensa "Nome do Repositório", digite um nome para o novo repositório e selecione Publicar no repositório privado do GitHub ou Publicar no repositório público do GitHub .

    Captura de tela da lista suspensa "Nome do Repositório" no VS Code

    O proprietário do novo repositório será a conta do GitHub com a qual você criou o codespace.

  6. No pop-up exibido no canto inferior direito do editor, clique em Abrir no GitHub para ver o novo repositório no GitHub.com. No novo repositório, veja o arquivo haikus.json e verifique se a alteração feita no codespace foi enviada com êxito para o repositório.

    Captura de tela do pop-up "Abrir no GitHub" no VS Code

Personalizando com uma extensão

Ao se conectar com um codespace usando o navegador ou o aplicativo da área de trabalho do Visual Studio Code, você pode acessar o Visual Studio Code Marketplace diretamente no editor. Neste exemplo, você instalará uma extensão do VS Code que altera o tema, mas você pode instalar qualquer extensão que seja útil para seu fluxo de trabalho.

  1. Na barra lateral esquerda, clique no ícone Extensões.

  2. Na barra de pesquisa, digite fairyfloss e clique em Instalar.

    Adicionar extensão

  3. Selecione o tema fairyfloss escolhendo-o na lista.

    Selecionar tema fairyfloss

Sobre a Sincronização de Configurações

Você pode habilitar a Sincronização de Configurações para sincronizar extensões e outras configurações entre dispositivos e instâncias do VS Code. Quando você habilita a Sincronização de Configurações em uma instância do VS Code, como o aplicativo de área de trabalho VS Code em seu laptop, suas configurações para essa instância são armazenadas na nuvem. Na nuvem, efetua-se pull das configurações para todos os novos codespaces no ponto de criação e elas são sincronizadas continuamente com quaisquer codespaces existentes em que a Sincronização de Configurações esteja habilitada.

Se a Sincronização de Configurações estará habilitada por padrão em um codespace dependerá das configurações existentes e de você abrir o codespace no navegador ou no aplicativo de área de trabalho VS Code. Para obter mais informações, confira "Como personalizar os GitHub Codespaces da sua conta".

Próximas etapas

Você criou com sucesso, personalizou e executou seu primeiro aplicativo em um codespace, mas há muito mais para explorar! Veja alguns recursos úteis para aprimorar o uso dos GitHub Codespaces.

Leitura adicional