copilot openai todo

? Copilot-openai-todo

Bei diesem Projekt handelt es sich um eine beispielhafte Todo-App-Implementierung, die zeigen soll, wie man mit GitHub Copilot eine KI-gestützte Todo-App mit Azure OpenAI und Azure Cosmos DB erstellt.

Der ausgefüllte Antrag befindet sich in der ausgefüllten Filiale.

Voraussetzungen

• Node.js v18+
• Docker v20+
• Azure-Konto . Wenn Sie neu bei Azure sind, erstellen Sie kostenlos ein Azure-Konto, um für den Einstieg kostenlose Azure-Credits zu erhalten.
• Azure-Abonnement mit aktiviertem Zugriff für den Azure OpenAI-Dienst . Mit diesem Formular können Sie den Zugang anfordern.
  • Alternativ können Sie anstelle des Azure OpenAI-Dienstes einen OpenAI-API-Schlüssel verwenden.

Sie können GitHub Codespaces verwenden, um direkt in Ihrem Browser an diesem Projekt zu arbeiten: Wählen Sie die Schaltfläche „Code“ , dann die Registerkarte „Codespaces“ und klicken Sie auf „Codespaces erstellen“ im Hauptmenü .

Sie können auch die Dev Containers-Erweiterung für VS Code verwenden, um lokal in einer gebrauchsfertigen Entwicklungsumgebung zu arbeiten.

Nachdem Sie das Projekt in Ihrer Entwicklungsumgebung geklont oder geöffnet haben, führen Sie den folgenden Befehl aus, um die Abhängigkeiten zu installieren:

npm install

Projektdetails

Dieses Projekt ist als Monorepo strukturiert und nutzt NPM Workspaces. Es ist wie folgt organisiert:

.devcontainer/    # Dev container configuration
.github/          # GitHub Actions CI/CD pipeline
packages/         # The different parts of our app
| - server/        # The Express server, hosting the API and the website
+- client/        # The website client
package.json      # NPM workspace configuration 

So erstellen Sie das Projekt

npm run build

Dieser Befehl erstellt die Client- und Serverpakete.

So richten Sie die Bereitstellung ein

Um die Ressourcen auf Azure bereitzustellen und die Dienste bereitzustellen, verwenden wir die Azure Dev CLI.

 # Only needed once
azd auth login --use-device-code

# Provision and deploy infrastructure
azd up

Sie können die Infrastruktur auch separat bereitstellen und bereitstellen:

 # Provision infrastructure
azd provision

# Deploy infrastructure
azd deploy

So führen Sie es lokal aus

Um die Anwendung lokal auszuführen, müssen Sie die folgenden Umgebungsvariablen in einer .env Datei im Stammverzeichnis des Projekts mit folgendem Inhalt einrichten:

AZURE_OPENAI_ENDPOINT= < your Azure OpenAI endpoint >
AZURE_COSMOS_DB_ENDPOINT= < your Azure Cosmos DB endpoint >

Da die Anwendung für die OpenAI-Vervollständigungen und den Cosmos DB-Speicher auf Azure-Dienste angewiesen ist, müssen Sie diese Ressourcen zuerst in Azure bereitstellen (siehe So richten Sie die Bereitstellung ein).

Führen Sie dann die folgenden Befehle aus, um Ihre .env Datei zu generieren:

azd env get-values > .env

Sobald Ihre .env Datei fertig ist, können Sie die Anwendung starten, indem Sie den folgenden Befehl im Stammverzeichnis des Projekts ausführen:

npm run start

Dadurch werden sowohl der Client als auch der Server ausgeführt:

• Der Client ist unter http://localhost:4200 verfügbar.
• Der Server wird unter http://localhost:3000 verfügbar sein.

Mitwirken

Dieses Projekt freut sich über Beiträge und Vorschläge. Für die meisten Beiträge müssen Sie einem Contributor License Agreement (CLA) zustimmen, in dem Sie erklären, dass Sie das Recht haben, uns die Rechte zur Nutzung Ihres Beitrags zu gewähren, und dies auch tatsächlich tun. Weitere Informationen finden Sie unter https://cla.opensource.microsoft.com.

Wenn Sie eine Pull-Anfrage einreichen, ermittelt ein CLA-Bot automatisch, ob Sie eine CLA bereitstellen müssen, und schmückt die PR entsprechend (z. B. Statusprüfung, Kommentar). Folgen Sie einfach den Anweisungen des Bots. Sie müssen dies nur einmal für alle Repos tun, die unsere CLA verwenden.

Dieses Projekt hat den Microsoft Open Source Verhaltenskodex übernommen. Weitere Informationen finden Sie in den FAQ zum Verhaltenskodex oder wenden Sie sich bei weiteren Fragen oder Kommentaren an [email protected].

Marken

Dieses Projekt kann Marken oder Logos für Projekte, Produkte oder Dienstleistungen enthalten. Die autorisierte Nutzung von Microsoft-Marken oder -Logos unterliegt den Marken- und Markenrichtlinien von Microsoft und muss diesen entsprechen. Die Verwendung von Microsoft-Marken oder -Logos in geänderten Versionen dieses Projekts darf keine Verwirrung stiften oder eine Sponsorschaft durch Microsoft implizieren. Jegliche Verwendung von Marken oder Logos Dritter unterliegt den Richtlinien dieser Drittanbieter.