copilot openai todo

? copilote-openai-todo

Ce projet est un exemple d'implémentation d'application Todo, qui vise à montrer comment utiliser GitHub Copilot pour créer une application Todo basée sur l'IA à l'aide d'Azure OpenAI et d'Azure Cosmos DB.

La demande complétée se trouve dans la succursale complétée.

Conditions préalables

• Node.js v18+
• Docker v20+
• Compte Azure . Si vous êtes nouveau sur Azure, obtenez un compte Azure gratuitement pour obtenir des crédits Azure gratuits pour commencer.
• Abonnement Azure avec accès activé pour le service Azure OpenAI . Vous pouvez demander l'accès avec ce formulaire.
  • Vous pouvez également utiliser une clé API OpenAI au lieu du service Azure OpenAI.

Vous pouvez utiliser GitHub Codespaces pour travailler sur ce projet directement depuis votre navigateur : sélectionnez le bouton Code , puis l'onglet Codespaces et cliquez sur Create Codespaces sur main .

Vous pouvez également utiliser l'extension Dev Containers pour VS Code pour travailler localement à l'aide d'un environnement de développement prêt à l'emploi.

Après avoir cloné ou ouvert le projet dans votre environnement de développement, exécutez la commande suivante pour installer les dépendances :

npm install

Détails du projet

Ce projet est structuré en monorepo et utilise NPM Workspaces. Il est organisé comme suit :

.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 

Comment construire le projet

npm run build

Cette commande construira les packages client et serveur.

Comment configurer le déploiement

Pour provisionner les ressources sur Azure et déployer les services, nous utilisons Azure Dev CLI.

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

# Provision and deploy infrastructure
azd up

Vous pouvez également provisionner et déployer l'infrastructure séparément :

 # Provision infrastructure
azd provision

# Deploy infrastructure
azd deploy

Comment exécuter localement

Afin d'exécuter l'application localement, vous devrez configurer les variables d'environnement suivantes dans un fichier .env à la racine du projet avec le contenu suivant :

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

Comme l'application s'appuie sur les services Azure pour les complétions OpenAI et le stockage Cosmos DB, vous devrez d'abord provisionner ces ressources sur Azure (voir Comment configurer le déploiement).

Ensuite, exécutez les commandes suivantes pour générer votre fichier .env :

azd env get-values > .env

Une fois votre fichier .env prêt, vous pouvez démarrer l'application en exécutant la commande suivante à la racine du projet :

npm run start

Cela exécutera à la fois le client et le serveur :

• Le client sera disponible sur http://localhost:4200.
• Le serveur sera disponible sur http://localhost:3000.

Contribuer

Ce projet accueille les contributions et suggestions. La plupart des contributions nécessitent que vous acceptiez un contrat de licence de contributeur (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez effectivement, le droit d'utiliser votre contribution. Pour plus de détails, visitez https://cla.opensource.microsoft.com.

Lorsque vous soumettez une pull request, un robot CLA déterminera automatiquement si vous devez fournir un CLA et décorera le PR de manière appropriée (par exemple, vérification du statut, commentaire). Suivez simplement les instructions fournies par le bot. Vous n’aurez besoin de le faire qu’une seule fois pour tous les dépôts utilisant notre CLA.

Ce projet a adopté le code de conduite Microsoft Open Source. Pour plus d’informations, consultez la FAQ sur le code de conduite ou contactez [email protected] pour toute question ou commentaire supplémentaire.

Marques déposées

Ce projet peut contenir des marques ou des logos pour des projets, des produits ou des services. L'utilisation autorisée des marques ou logos Microsoft est soumise et doit respecter les directives relatives aux marques et aux marques de Microsoft. L'utilisation des marques ou logos Microsoft dans les versions modifiées de ce projet ne doit pas prêter à confusion ni impliquer le parrainage de Microsoft. Toute utilisation de marques ou de logos tiers est soumise aux politiques de ces tiers.