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 un equipo con otros colaboradores, puedes personalizar tu entorno de forma precisa para tu proyecto y, luego, confirmar tu archivo .idx/dev.nix en el repositorio de Git de tu proyecto. De esta manera, cuando un compañero de equipo importe tu repositorio de Git en IDX, su nuevo espacio de trabajo tendrá la misma configuración que la tuya, con los mismos paquetes del sistema, extensiones de IDE, secuencias de comandos de inicio y mucho más.

  • Si compiles un framework o una biblioteca para que otros lo 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 a probar tu framework directamente. Incluso puedes crear tu propia plantilla personalizada como un punto de partida personalizable y con opiniones para tus usuarios.

Una vez que estés conforme con las personalizaciones de tu entorno, puedes hacer que sea aún más fácil para otras personas importar tu proyecto a IDX. Para ello, agrega un botón "Open in IDX" a tu documentación, como el archivo README.md de tu proyecto.

Puntos de entrada comunes de "Abrir en IDX"

Existen varios patrones de URL disponibles para un botón "Open in IDX":

  • Para vincular al flujo Importar un repositorio de Git, prepropagado 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
    

    Por el momento, solo se admiten repositorios de GitHub (tanto privados como públicos).

  • Para vincular a una plantilla de espacio de trabajo predefinida, busca la plantilla que buscas en la página Plantillas de 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, preproporcionada 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"

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