Adicione um botão "Abrir no IDX"

Com o Project IDX, você pode simplificar as etapas para que alguém novo no seu código-base configure o ambiente de desenvolvimento e comece a trabalhar.

Por exemplo,

  • Se você trabalha em uma equipe com outros colaboradores, é possível personalizar seu ambiente com precisão para o projeto e, em seguida, 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 terá a mesma configuração que o seu, com os mesmos pacotes de sistema, extensões de IDE, scripts de inicialização e muito mais.

  • Se você estiver criando uma estrutura ou biblioteca para outras pessoas usarem, inclua um arquivo .idx/dev.nix nos repositórios de código de exemplo. Assim, quando um usuário importar seus exemplos para o IDX, ele poderá pular a configuração do ambiente e testar diretamente sua estrutura. Você pode até criar seu próprio modelo personalizado como um ponto de partida personalizável e opinativo para os usuários.

Quando estiver satisfeito com as personalizações do ambiente, você pode 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 "Abrir no IDX"

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

  • Para vincular ao fluxo import a Git repository, preenchido com o URL do repositório do Git, use este padrão de URL:

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

    No momento, apenas os repositórios do GitHub (privados e públicos) são compatíveis.

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

    https://idx.google.com/new/gemini
    
  • Para vincular a um modelo personalizado, preenchido com o URL do GitHub do 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: