Mit Project IDX können Sie die Schritte für Personen vereinfachen, die Ihre Codebasis nicht kennen, um ihre Entwicklungsumgebung einzurichten und produktiv zu arbeiten.
Beispiel:
Wenn Sie in einem Team mit anderen Mitwirkenden zusammenarbeiten, können Sie Ihre Umgebung genau für Ihr Projekt anpassen und dann Ihre
.idx/dev.nix
-Datei in das Git-Repository Ihres Projekts committen. Wenn ein Teammitglied Ihr Git-Repository in IDX importiert, hat sein neuer Arbeitsbereich genau dieselbe Konfiguration wie Ihr eigener, einschließlich derselben Systempakete, IDE-Erweiterungen, Startscripts und mehr.Wenn Sie ein Framework oder eine Bibliothek für andere Nutzer erstellen, können Sie eine
.idx/dev.nix
-Datei in Ihre Beispielcode-Repositories aufnehmen. Wenn ein Nutzer dann Ihre Samples in IDX importiert, kann er die Umgebungseinrichtung überspringen und direkt mit dem Testen Ihres Frameworks beginnen. Sie können sogar eine eigene benutzerdefinierte Vorlage erstellen, die als aussagekräftiger, anpassbarer Ausgangspunkt für Ihre Nutzer dient.
Wenn Sie mit den Anpassungen Ihrer Umgebung zufrieden sind, können Sie anderen Nutzern das Importieren Ihres Projekts in IDX noch einfacher machen. Fügen Sie dazu Ihrer Dokumentation eine Schaltfläche „In IDX öffnen“ hinzu, z. B. in der README.md
-Datei Ihres Projekts.
Gängige Einstiegspunkte für „In IDX öffnen“
Für die Schaltfläche „In IDX öffnen“ gibt es mehrere URL-Muster:
Wenn Sie einen Link zum Ablauf Git-Repository importieren erstellen möchten, der bereits mit der URL Ihres Git-Repositorys ausgefüllt ist, verwenden Sie dieses URL-Muster:
https://idx.google.com/import?url=https://github.com/my-org/my-repo
Derzeit werden nur GitHub-Repositories unterstützt (sowohl private als auch öffentliche).
Wenn Sie einen Link zu einer vordefinierten Arbeitsbereichsvorlage herstellen möchten, suchen Sie in IDX auf der Seite Vorlagen nach der gewünschten Vorlage und kopieren Sie die URL. Diese muss dem folgenden URL-Muster entsprechen:
https://idx.google.com/new/gemini
Wenn Sie einen Link zu einer benutzerdefinierten Vorlage herstellen möchten, die bereits mit der GitHub-URL Ihrer Vorlage ausgefüllt ist, verwenden Sie dieses URL-Muster:
https://idx.google.com/new?template=https://github.com/my-org/my-template
Schaltfläche „In IDX öffnen“ hinzufügen
Mit diesem Tool können Sie das HTML für eine IDX-Schaltfläche generieren: