Agrega un botón "Abrir en IDX"

Con Project IDX, puedes simplificar los pasos para que alguien nuevo en tu base de código configure su entorno de desarrollo y sea productivo.

Por ejemplo,

  • Si trabajas en equipo con otros colaboradores, puedes personalizar tu entorno precisamente para tu proyecto y, luego, confirmar tu archivo .idx/dev.nix en el repositorio Git de tu proyecto. De esa manera, cuando un compañero de equipo importe tu repositorio de Git en IDX, su nuevo lugar de trabajo tendrá exactamente la misma configuración que el tuyo, con los mismos paquetes de sistema, extensiones de IDE, secuencias de comandos de inicio y mucho más.

  • Si estás compilando un framework o una biblioteca para que otros los usen, puedes incluir un archivo .idx/dev.nix en tus repositorios de código de muestra, de modo que cuando un usuario importe tus muestras a IDX, pueda omitir la configuración del entorno y comenzar directamente a probar tu framework. Incluso puedes crear tu propia plantilla personalizada como un punto de partida definido y personalizable para tus usuarios.

Una vez que estés conforme con las personalizaciones de tu entorno, puedes hacer que sea más fácil para otros importar tu proyecto a IDX agregando el botón “Abrir en IDX” a tu documentación, como el archivo README.md de tu proyecto.

Puntos de entrada comunes "Abrir en IDX"

Hay varios patrones de URL disponibles para el botón "Abrir en IDX" disponibles:

  • Para vincular el flujo de importación de un repositorio de Git, completada previamente con la URL de tu repositorio de Git, usa este patrón de URL:

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

    En este momento, solo se admiten repositorios de GitHub (privados y públicos).

  • Para vincular a una plantilla de lugar de trabajo predefinida, busca la plantilla que buscas en la página Plantillas en IDX y copia su URL, que debe seguir este patrón de URL:

    https://idx.google.com/new/gemini
    
  • Para vincular a una plantilla personalizada, completada previamente con la URL de GitHub de tu plantilla, usa este patrón de URL:

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

Agrega un botón "Abrir en IDX"

Utiliza esta herramienta para generar el código HTML de un botón IDX: