What is Spartacus?
If you are working with an older version of the Spartacus libraries, you can find the full suite of corresponding documentation in our Documentation Archive.
Spartacus is also an open source project. You can view the Spartacus source code in this GitHub repository.
See the following introductory videos for a quick overview of Spartacus:
Table of Contents
- Open Source
- Storefront Features
- Download and Installation
- Customizing and Extending Spartacus
- Known Issues
- How to Obtain Support
- Public Instance of Spartacus
- To Do
Spartacus is designed to be upgradable while maintaining full extendability. You'll be able to adopt new versions of Spartacus by updating the Spartacus libraries that we will regularly enhance.
Version 1.0.0 was released July 4, 2019, a month after SAP Commerce Cloud 1905.
Spartacus is on a journey to be fully compliant with the Progressive Web Application (PWA) checklist. We aim to add support for all major features of a PWA-enabled storefront, to offer the best possible customer experience regardless of device or location.
Spartacus is open source. It will be continually developed by the SAP Commerce Cloud team, but we are very keen to welcome contributors and to foster an inclusive, active development community for Spartacus.
See Contributing to the Spartacus Storefront for more information.
The Spartacus storefront is part of our exciting new journey towards a customizable-yet-upgradable technology for SAP Commerce Cloud installations.
See SAP Customer Experience for more information about SAP Commerce Cloud.
Spartacus provides core storefront features such as:
- home page
- product details
- cart page
- adding to cart
- order history
Your Angular development environment should include the following:
- Angular CLI: Version 10.1 or later, < 11.
- Node.js: The most recent 12.x version is recommended, < 13.
- Yarn: Version 1.15 or later.
For the back end, SAP Commerce Cloud version 1905 or higher is required, and SAP Commerce Cloud version 2005 or newer is recommended.
Note: Some Spartacus features require API endpoints that are only available in newer versions of SAP Commerce Cloud. For more information, see Feature Compatibility.
Download and Installation
To get up and running with Spartacus, the recommended approach is to build your storefront application from ready-made libraries. You can also clone and build from source, but upgrading is not as simple.
Spartacus currently can only be used with a SAP Commerce Cloud instance through Commerce APIs.
For complete setup instructions, see the Building the Spartacus Storefront from Libraries guide.
Customizing and Extending Spartacus
To maintain our promise of upgradability, the design pattern for Spartacus is for non-core features to be built as feature libraries that add to or change the provided functionality.
When using Spartacus, you build an app that pulls in the Spartacus libraries, which contain the core resources needed to work with SAP Commerce Cloud. You then build new features that contain any custom functionality and pages.
Content for Spartacus pages is fetched from the SAP Commerce Cloud CMS (Content Management System), such as logos, links, banners and static pages. We recommend that new content-driven features follow the same pattern to enable Content Managers to modify page content through the CMS tools.
The documentation for customizing and extending Spartacus is still under development and is being released as it becomes available.
With the release of 1.0.0, it is recommended to use SAP Commerce Cloud 1905. Spartacus works with Release 1808 and 1811 of SAP Commerce Cloud, with some limitations.
Spartacus is also being updated so that it works well with upcoming releases of SAP Commerce Cloud. This means that certain features of Spartacus may only work with unreleased future editions of SAP Commerce Cloud. This will be noted as we release new versions of Spartacus.
Known issues are documented in the GitHub issue tracking system.
How to Obtain Support
You can get support for Spartacus in the following ways:
- Get answers from our developers and the Spartacus community by asking a question on Stack Overflow.
- Problem or bug? If you have a SAP Commerce Cloud license, create a customer support ticket.
- For non-technical questions, you can reach us on our Slack workspace.
Team Spartacus welcomes feedback, ideas, requests, and especially code contributions.
- Post comments to our feedback channel in our Slack workspace.
- Read Contributing to the Spartacus Storefront to learn how to:
- Help others
- Report an issue
- Contribute code to Spartacus
Public Instance of Spartacus
This public instance of Spartacus is running on SAP Commerce Cloud (CCv2).
We may have our latest version on the link above, but in the future we hope to update our deployments quickly and frequently.
Many improvements are coming! All tasks will be posted to our GitHub issue tracking system. As mentioned, some of the improvements will mean breaking changes. While we strive to avoid doing so, we cannot guarantee this will not happen before the first release.
Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.