Adicione um botão "Abrir no IDX"

Com o Project IDX, é possível simplificar as etapas para alguém novo na sua base de código configurar o ambiente de desenvolvimento dele e aumentar a produtividade.

Por exemplo:

  • Se você está trabalhando em uma equipe com outros colaboradores, é possível personalizar seu ambiente com precisão para o projeto e confirmar o arquivo .idx/dev.nix no repositório Git do projeto. Dessa forma, quando um colega de equipe importar seu repositório Git no IDX, o novo espaço de trabalho dele terá exatamente a mesma configuração que o seu, completo com os mesmos pacotes de sistema, extensões de ambiente de desenvolvimento integrado, scripts iniciais e muito mais.

  • Se você estiver criando um framework ou uma biblioteca para outras pessoas usarem, inclua um arquivo .idx/dev.nix nos repositórios de código de amostra. Assim, quando um usuário importar suas amostras para o IDX, poderá pular a configuração do ambiente e ir direto para o teste do framework. É possível até criar seu próprio modelo personalizado como um ponto de partida opinativo e personalizável para seus usuários.

Quando estiver satisfeito com as personalizações do ambiente, você poderá facilitar ainda mais a importação do projeto para o IDX adicionando um botão "Abrir no IDX" à documentação, como o arquivo README.md do projeto.

Pontos de entrada comuns de "Open in IDX"

Existem vários padrões de URL disponíveis para o botão "Abrir no IDX":

  • Para vincular o fluxo de importação de um repositório Git, preenchido previamente com o URL do repositório Git, use este padrão de URL:

    https://idx.google.com/import?url=https://github.com/my-org/my-repo
    

    No momento, só há suporte para repositórios do GitHub (particulares e públicos).

  • Para vincular a um modelo de espaço de trabalho predefinido, encontre aquele que você está procurando na página Modelos no IDX e copie o URL, que precisa seguir este padrão:

    https://idx.google.com/new/gemini
    
  • Para vincular a um modelo personalizado, preenchido automaticamente com o URL do GitHub do seu modelo, use este padrão de URL:

    https://idx.google.com/new?template=https://github.com/my-org/my-template
    

Adicionar um botão "Abrir no IDX"

Use esta ferramenta para gerar o HTML de um botão IDX: