copilot openai todo

? copiloto-openai-todo

Este proyecto es un ejemplo de implementación de una aplicación Todo, cuyo objetivo es mostrar cómo usar GitHub Copilot para crear una aplicación de tareas pendientes impulsada por IA utilizando Azure OpenAI y Azure Cosmos DB.

La solicitud completa se encuentra en la sucursal completa.

Requisitos previos

• Nodo.js v18+
• ventana acoplable v20+
• Cuenta de Azure . Si es nuevo en Azure, obtenga una cuenta de Azure gratis para obtener créditos de Azure gratuitos para comenzar.
• Suscripción de Azure con acceso habilitado para el servicio Azure OpenAI . Puedes solicitar acceso con este formulario.
  • Como alternativa, puede usar una clave API de OpenAI en lugar del servicio Azure OpenAI.

Puedes usar GitHub Codespaces para trabajar en este proyecto directamente desde tu navegador: selecciona el botón Código , luego la pestaña Codespaces y haz clic en Crear Codespaces en principal .

También puede usar la extensión Dev Containers para VS Code para trabajar localmente usando un entorno de desarrollo listo para usar.

Después de clonar o abrir el proyecto en su entorno de desarrollo, ejecute el siguiente comando para instalar las dependencias:

npm install

Detalles del proyecto

Este proyecto está estructurado como monorepo y utiliza NPM Workspaces. Está organizado de la siguiente manera:

.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 

Cómo construir el proyecto

npm run build

Este comando construirá los paquetes de cliente y servidor.

Cómo configurar la implementación

Para aprovisionar los recursos en Azure e implementar los servicios, utilizamos la CLI de desarrollo de Azure.

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

# Provision and deploy infrastructure
azd up

También puede aprovisionar e implementar la infraestructura por separado:

 # Provision infrastructure
azd provision

# Deploy infrastructure
azd deploy

Cómo ejecutar localmente

Para ejecutar la aplicación localmente, necesitará configurar las siguientes variables de entorno en un archivo .env en la raíz del proyecto con el siguiente contenido:

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

Como la aplicación depende de los servicios de Azure para las completaciones de OpenAI y el almacenamiento de Cosmos DB, primero deberá aprovisionar estos recursos en Azure (consulte Cómo configurar la implementación).

Luego, ejecute los siguientes comandos para generar su archivo .env :

azd env get-values > .env

Una vez que su archivo .env esté listo, puede iniciar la aplicación ejecutando el siguiente comando en la raíz del proyecto:

npm run start

Esto ejecutará tanto el cliente como el servidor:

• El cliente estará disponible en http://localhost:4200.
• El servidor estará disponible en http://localhost:3000.

Contribuyendo

Este proyecto agradece contribuciones y sugerencias. La mayoría de las contribuciones requieren que usted acepte un Acuerdo de licencia de colaborador (CLA) que declara que tiene derecho a otorgarnos, y de hecho lo hace, los derechos para usar su contribución. Para obtener más detalles, visite https://cla.opensource.microsoft.com.

Cuando envía una solicitud de extracción, un bot CLA determinará automáticamente si necesita proporcionar un CLA y decorar el PR de manera adecuada (por ejemplo, verificación de estado, comentario). Simplemente siga las instrucciones proporcionadas por el bot. Solo necesitarás hacer esto una vez en todos los repositorios que utilicen nuestro CLA.

Este proyecto ha adoptado el Código de conducta de código abierto de Microsoft. Para obtener más información, consulte las preguntas frecuentes sobre el Código de conducta o comuníquese con [email protected] si tiene alguna pregunta o comentario adicional.

Marcas registradas

Este proyecto puede contener marcas comerciales o logotipos de proyectos, productos o servicios. El uso autorizado de las marcas comerciales o logotipos de Microsoft está sujeto y debe seguir las Pautas de marcas y marcas comerciales de Microsoft. El uso de marcas comerciales o logotipos de Microsoft en versiones modificadas de este proyecto no debe causar confusión ni implicar patrocinio de Microsoft. Cualquier uso de marcas comerciales o logotipos de terceros está sujeto a las políticas de dichos terceros.