Spartacus is a lean, Angular-based JavaScript storefront for SAP Commerce Cloud that communicates exclusively through the Commerce REST API.
Clone or download
tobi-or-not-tobi feat (@spartacus/storefront) Cleanup header styling (#896)
* simplify tertiary nav

* use cx convention for css vars

* Simplified layout using flexbox

* simple "container" solution

* Generate and use css classname based on slot position

* Simplified and optimized select styles

* reuse selector component styles in 2 components

* bonus – only show selectors if there's something to select

* remove align as it will be inherited

* Optimize category navigation styles

* Reorder elements in mobile view

* inherit color

* improve alignment on mobile view

* control overall margins by layout, not by components

* refactor header styles

* trash the obsolete mobile nav

* drop hardcoded hamburger

* reflect header design with smaller links and selectors

* fix lint issue

* revert skipper

* simplify selectors

* add margin in navigation and wrap items temporarily

* fix tests

* Allow for host property in components

* inherit colors

* bypass sonar/scss issues
Latest commit c13ec31 Jan 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode cleaned extensions.json Nov 22, 2018
ci-scripts ci: Fixing deploy to github pages Dec 18, 2018
docs added info regarding e2e tests (#880) Jan 15, 2019
mock-server SPA-1348: Very tiny tweaks to the text. Oct 9, 2018
projects feat (@spartacus/storefront) Cleanup header styling (#896) Jan 16, 2019
scripts ci: Generate changelog from commit messages Jan 14, 2019
.editorconfig SPA-434: Generated brand new Andular 6 app. May 11, 2018
.gitignore Adding config for sonarcloud scan Nov 6, 2018
.prettierignore feature/GH-367: add webApplicationInjector.js to .prettierignore Dec 3, 2018
.prettierrc GH-332: Updgrated prettier version and added html support Nov 23, 2018
.travis.yml ci: Add protractor report as artifact (#790) Jan 3, 2019
CONTRIBUTING.md doc: Top-to-bottom edit of Contributing.md (#481) Dec 7, 2018
ISSUE_TEMPLATE.md added info regarding e2e tests (#880) Jan 15, 2019
Jenkinsfile SPA-434: Move back relevant files in the root folder. May 11, 2018
LICENSE.txt SPA-1074 Adding license and notice Sep 21, 2018
NOTICE.txt SPA-1074 Adding license and notice Sep 21, 2018
README.md docs: Update requirement versions in the documentation (GH-860) Jan 11, 2019
angular.json feat: Basic SSR suport (#778) Jan 9, 2019
build.sh fixed build.sh Nov 30, 2018
configure-shellapp.js SPA-1298: Fix for installation installation script blocker. Oct 1, 2018
configure-shellapp.json SPA-1110: Add storefrontstyles as dependency to shellapp Sep 19, 2018
deploy-shellapp.sh Bumping version to v0.0.1-1 manually Jun 6, 2018
generate-shellapp.sh SPA-1363 removing shellapp readme Oct 9, 2018
package.json ci: Generate changelog from commit messages Jan 14, 2019
release-styles.sh Updating release scripts Feature/spa 1335 (#41) Oct 30, 2018
release.sh Release/1811-23 (#423) Nov 27, 2018
sonar-project.properties GH-165 Adding extra sonar configs Nov 7, 2018
spartacus_demo.md SPA-503 demo info Oct 10, 2018
tsconfig.json GH-300: Review fixes Nov 29, 2018
tslint.json feat (@spartacus/storefront) Cleanup header styling (#896) Jan 16, 2019
yarn.lock ci: Generate changelog from commit messages Jan 14, 2019

README.md

JavaScript storefront (spartacus)

What is Spartacus?

Spartacus is a lean, Angular-based JavaScript storefront for SAP Commerce Cloud. Spartacus talks to SAP Commerce Cloud exclusively through the Commerce REST API.

Extendable

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.

We’re making great progress and are planning our first beta in Q1 2019 and a launch date in Q2 2019. In the meantime, in order to ensure that the first release is as extendable and upgradable as we'd like, breaking changes will very likely be introduced. Please keep that in mind if you decide to start a project using the Spartacus storefront, prior to the first release.

Progressive

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.

Open Source

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 our contributing documentation for more information.

Technology

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.

Storefront features

Spartacus provides core storefront features such as:

  • home page
  • search
  • categories
  • product details
  • cart page
  • adding to cart
  • checkout
  • order history

Requirements

  • SAP Commerce Cloud instance (Release 1811)
  • Angular CLI (https://angular.io/): >= 7.2.1 and < 8.0.0
  • node.js >= 10.14.1
  • yarn >= 1.9.4

Download and Installation

To get up and running with Spartacus, the simplest approach is to build the application from ready-made libraries. You can also clone and build from source.

Spartacus currently can only be used with a SAP Commerce Cloud instance through Commerce APIs. In the future, you will be able to use Spartacus with a mock server.

For complete setup instructions, see the Setup and Installation 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.

Spartacus comes with an application shell (storefrontapp) that contains core resources that are needed to load the rest of the web app. These core resources are provided through libraries, such as the storefrontlib and storefrontstylelib. You then build new feature libraries that contain any custom functionality and pages. It is recommended to keep the shell app as a container for libraries and to avoid developing features directly in the shell app.

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 will be released soon.

Limitations

Spartacus works with Release 1808 of SAP Commerce Cloud, with some limitations. See the Setup and Installation guide for more information.

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

Known issues are documented in the GitHub issue tracking system.

How to Obtain Support

Spartacus is provided "as-is" with no official lines of support.

To get help from the Spartacus community:

Contributing

Team Spartacus welcomes feedback, ideas, requests, and especially code contributions.

  • Post comments to our Feedback chat in our Slack channel.
  • Read the Contributing document and learn how to:
    • Help others
    • Report an issue
    • Contribute code to Spartacus

To Do

Many changes are coming! Most tasks will be posted to our GitHub issue tracking system, and this section will be updated with the major roadmap items.

Some of the upcoming features or changes to the open source release:

  • Mock server
  • Personal information pages (My Account, Payment Management, Address Management)
  • Extensibility examples
  • Style customization examples
  • Performance improvements through App Shell Caching
  • Completion of test coverage, including end-to-end tests

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.

License

Copyright (c) 2018 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.