Espartaco

Spartacus y el escaparate componible

¡Hola y bienvenido!

Este README es parte de la rama develop , que es una rama de desarrollo activa en el repositorio de Spartacus. Como tal, el siguiente texto puede contener referencias a trabajos que están en progreso y que aún no se han publicado oficialmente.

A partir de la versión 2211.19, el escaparate componible ha alineado su control de versiones con SAP Commerce Cloud. La versión anterior del escaparate componible era la versión 6.8. Para obtener más información, consulte Cambios en la numeración de versiones y las políticas de actualización para Composable Storefront a partir de febrero de 2024.

A partir de la versión 5.0, “SAP Commerce Cloud, escaparate componible” es el nombre del lanzamiento oficial de las bibliotecas del proyecto “Spartacus” publicadas por SAP. El escaparate componible con soporte oficial está disponible para los clientes de SAP Commerce Cloud. La documentación está disponible en el Portal de ayuda de SAP.

El escaparate componible se basa en el código fuente abierto de Spartacus y se incluye en la licencia de SAP Commerce Cloud sin costo adicional. El escaparate componible tiene una política de actualización progresiva.

Los clientes locales aún pueden utilizar el código abierto de Spartacus. Para obtener más información, consulte Bibliotecas Spartacus de autoedición utilizando código fuente abierto.

¿Qué es Espartaco?

Spartacus es un escaparate de JavaScript sencillo y basado en Angular para SAP Commerce Cloud. Spartacus habla con SAP Commerce Cloud exclusivamente a través de la API REST de Commerce.

• La documentación está disponible en el Portal de ayuda de SAP.
• Pruebe una muestra de escaparate de Spartacus en nuestro sitio de demostración público.
• ¿Preguntas técnicas? Póngase en contacto con nosotros en Stack Overflow.
• ¿Preguntas no técnicas? Únase a nuestro espacio de trabajo de Slack.
• Para obtener detalles sobre el lanzamiento 4.0, consulte la página Información de la versión en el Portal de ayuda de SAP.

Espartaco es...

• Extensible : Spartacus está diseñado para ser actualizable manteniendo al mismo tiempo la capacidad de extensión total. Podrás adoptar nuevas versiones de Spartacus actualizando las bibliotecas de Spartacus que mejoraremos periódicamente. (Para garantizar que la primera versión sea tan ampliable y actualizable como nos gustaría, es muy probable que se introduzcan cambios importantes hasta el lanzamiento de la versión 1.0).
• Actualizable : el código Spartacus se publica y utiliza como bibliotecas y sigue convenciones de control de versiones semánticas. Al utilizar las bibliotecas, Spartacus se puede actualizar para versiones menores y de parches.
• Progresivo : Spartacus está en camino de cumplir plenamente con la lista de verificación de aplicaciones web progresivas (PWA). Nuestro objetivo es agregar soporte para todas las funciones principales de un escaparate habilitado para PWA, para ofrecer la mejor experiencia posible al cliente independientemente del dispositivo o la ubicación.
• Código abierto : Spartacus es de código abierto. El equipo de SAP Commerce Cloud lo desarrollará continuamente, pero estamos muy interesados ​​en dar la bienvenida a los contribuyentes y fomentar una comunidad de desarrollo activa e inclusiva para Spartacus. Consulte nuestra documentación de contribución para obtener más información.
• Moderno : el escaparate Spartacus es parte de nuestro nuevo y emocionante viaje hacia una tecnología personalizable pero actualizable para las instalaciones de SAP Commerce Cloud. Consulte Experiencia del cliente de SAP para obtener más información sobre SAP Commerce Cloud.

Características del escaparate

Spartacus ofrece funciones principales de escaparate como:

• pagina de inicio
• Buscar
• Categorías
• Detalles del producto
• Página del carrito
• Agregando al carrito
• Verificar
• Historial de pedidos

Consulte la documentación de la versión en el Portal de ayuda de SAP para obtener más información.

Requisitos

Si está trabajando con Spartacus 2211, consulte los requisitos del entorno de desarrollo Angular 2211 en el Portal de ayuda de SAP.

Si está trabajando con Spartacus 6.x, consulte los requisitos relevantes del entorno de desarrollo Angular 6.x en el Portal de ayuda de SAP.

Si está trabajando con Spartacus 5.x, consulte los requisitos relevantes del entorno de desarrollo Angular 5.x en el Portal de ayuda de SAP.

Para conocer los requisitos de back-end, consulte la Matriz de compatibilidad de Composable Storefront.

Si está trabajando con Spartacus 4.x, su entorno de desarrollo Angular debe incluir lo siguiente:

• CLI angular: 12.0 o posterior, <13.
• hilo: v1.15 o posterior
• node.js: se requiere la versión 14.15 . La versión 12.x llegó al final de su vida útil el 30 de abril de 2022 y Spartacus ya no la admite. Se recomienda encarecidamente migrar cualquier tienda Spartacus existente a Node.js 14 lo antes posible. Si hay algún problema con Spartacus y Node.js 14, actualice a las últimas versiones. Si continúa teniendo problemas con Node.js 14, cree un ticket de soporte con SAP. Spartacus también admite la versión 16.x de Node.js, pero esta versión aún no es compatible con Commerce Cloud en el generador de nube pública.

Si está trabajando con Spartacus 3.x, su entorno de desarrollo Angular debe incluir lo siguiente:

• CLI angular: 10.1 o posterior, <11.
• node.js: 12.16.1 o posterior, <13.0. Se recomienda la versión 12.x más reciente.
• hilo: v1.15 o posterior

Si está trabajando con Spartacus 2.x, su entorno de desarrollo Angular debe incluir lo siguiente:

• CLI angular: 9.1 o posterior, <10.
• node.js: 10.14.1 o posterior, <13.0. Se recomienda la versión 12.x más reciente.
• hilo: v1.15 o posterior

Si está trabajando con Spartacus 1.x, su entorno de desarrollo Angular debe incluir lo siguiente:

• CLI angular: v8.0.0 o posterior,
• node.js: v10 o posterior,
• hilo: v1.15 o posterior

Para el back-end, se requiere SAP Commerce Cloud versión 1905 o superior y se recomienda SAP Commerce Cloud versión 2005 o posterior.

Nota: Algunas funciones de Spartacus requieren puntos finales API que solo están disponibles en versiones más recientes de SAP Commerce Cloud. Para obtener más información, consulte Matriz de compatibilidad en el portal de ayuda de SAP.

Descarga e instalación

Para comenzar a utilizar Spartacus, el enfoque recomendado es crear su aplicación de escaparate a partir de bibliotecas ya preparadas. También puedes clonar y compilar desde el código fuente, pero actualizar no es tan sencillo.

Actualmente, Spartacus solo se puede utilizar con una instancia de SAP Commerce Cloud a través de las API de Commerce.

Para agregar rápidamente bibliotecas Spartacus a una aplicación Angular, puede usar los esquemas de Spartacus: ng add @spartacus/schematics . Esto configurará e instalará las bibliotecas Spartacus en su proyecto Angular. Consulte la documentación oficial de los esquemas de Spartacus para conocer todos los requisitos previos e instrucciones sobre cómo utilizar los esquemas de Spartacus.

Para obtener instrucciones de configuración completas, consulte Configuración del escaparate componible en el portal de ayuda de SAP.

Personalización y ampliación de Spartacus

Para mantener nuestra promesa de capacidad de actualización, el patrón de diseño de Spartacus es que las funciones no principales se creen como bibliotecas de funciones que agregan o cambian la funcionalidad proporcionada.

Cuando usa Spartacus, crea una aplicación que extrae las bibliotecas de Spartacus, que contienen los recursos principales necesarios para trabajar con SAP Commerce. Luego, crea nuevas funciones que contienen funciones y páginas personalizadas.

El contenido de las páginas de Spartacus se obtiene del CMS (sistema de gestión de contenidos) de SAP Commerce Cloud, como logotipos, enlaces, pancartas y páginas estáticas. Recomendamos que las nuevas funciones basadas en contenido sigan el mismo patrón para permitir que los administradores de contenido modifiquen el contenido de la página a través de las herramientas CMS.

La documentación para personalizar y ampliar Spartacus aún está en desarrollo y se publicará a medida que esté disponible.

Documentación de la aplicación Spartacus

Versión 5.x y posteriores

Consulte API de escaparate componible.

Versión 4.x y anteriores

La documentación generada más recientemente para las bibliotecas de aplicaciones Spartacus (módulos, clases, interfaces, etc.) se encuentra aquí: https://sap.github.io/spartacus/

La documentación de la aplicación tiene versiones y se incluye en la sección Activos de cada versión de todas y cada una de las bibliotecas de Spartacus. Puede descargar la documentación de una versión en particular accediendo a la sección Recursos de cualquier biblioteca Spartacus de esa versión en particular y luego haciendo clic en docs.tar.gz o docs.zip . Para encontrar la carpeta Recursos de una biblioteca en particular, acceda a Bibliotecas publicadas para Spartacus, haga clic en el enlace de la biblioteca que le interesa y desplácese hasta la parte inferior de la página.

Por ejemplo, para descargar la documentación de la aplicación para la versión 3.4.0, puede acceder a la carpeta Activos de la biblioteca @spartacus/[email protected] aquí.

Nota: Las versiones 1.x y 2.x de las bibliotecas Spartacus funcionan sólo con las versiones 1905 y 2005 de SAP Commerce. Ciertas funciones, como cancelaciones y devoluciones, sólo están disponibles con SAP Commerce 2005, porque el soporte API OCC necesario sólo está disponible disponible en SAP Commerce 2005.

Limitaciones

Cuando se lanza 1.0.0, se recomienda utilizar SAP Commerce 1905. Spartacus funciona con las versiones 1808 y 1811 de SAP Commerce Cloud, con algunas limitaciones.

Spartacus también se está actualizando para que funcione bien con las próximas versiones de SAP Commerce Cloud. Esto significa que es posible que determinadas funciones de Spartacus solo funcionen con ediciones futuras inéditas de SAP Commerce Cloud. Esto se notará a medida que lancemos nuevas versiones de Spartacus.

Problemas conocidos

Los problemas conocidos están documentados en el sistema de seguimiento de problemas de GitHub.

Cómo obtener soporte

Spartacus se proporciona "tal cual" sin líneas oficiales de apoyo.

Para obtener ayuda de la comunidad Spartacus:

• Si tiene preguntas de los desarrolladores, publique una pregunta en Stack Overflow con la etiqueta 'spartacus'.

Contribuyendo

El equipo Spartacus agradece comentarios, ideas, solicitudes y, especialmente, contribuciones de código.

• Lea el documento de contribución y aprenda cómo:
  • Ayuda a otros
  • Informar un problema
  • Contribuir con código a Spartacus

Hacer

¡Se avecinan muchas mejoras! Todas las tareas se publicarán en nuestro sistema de seguimiento de problemas de GitHub. Como se mencionó, algunas de las mejoras significarán cambios importantes. Si bien nos esforzamos por evitarlo, no podemos garantizar que esto no suceda antes del primer lanzamiento.

Licencia

Copyright (c) 2024 SAP SE o una empresa filial de SAP. Reservados todos los derechos. Este archivo tiene la licencia de software Apache, v. 2, salvo que se indique lo contrario en el archivo de LICENCIA.