How sap/spartacus works
Spartacus is an Angular composable storefront for SAP Commerce Cloud. A shopper uses storefront experiences for discovery, product details, cart, checkout, and order history; the storefront communicates with Commerce through its REST API, while CMS content supplies page structure and content. The repository also provides shared authentication, state/events, and server-side rendering. Feature and integration directories document substantial capabilities beyond the sampled implementation; links between those unsampled modules are omitted unless the README or excerpts support them.
Main entry points: app.module.ts Storefront app · checkout-query.service.ts Checkout query · ng-express-engine-decorator.ts SSR decorator · checkout-flow-orchestrator.service.ts Checkout
Components 23
Storefront experience
- Storefront app
projects/storefrontapp/src/app/app.module.ts - CMS pages
core-libs/core/src/cms - Search
core-libs/storefront/cms-components/navigation/search-box/search-box-component.service.ts
Commerce journeys
- Product details
feature-libs/product - Cart
feature-libs/cart/base/core/facade/active-cart.service.ts - Checkout
feature-libs/checkout/base/components/services/checkout-flow-orchestrator.service.ts - Checkout query
feature-libs/checkout/base/core/facade/checkout-query.service.ts - Order history
feature-libs/order/core/facade/my-account-v2-order-history.service.ts
Core platform
- User authentication
core-libs/core/src/auth/user-auth - Client authentication
core-libs/core/src/auth/client-auth - Anonymous consent
core-libs/core/src/anonymous-consents - Configuration
core-libs/core/src/config - Feature toggles
core-libs/core/src/features-config - Internationalization
core-libs/core/src/i18n - Event service
core-libs/core/src/event/event.service.ts - Query service
core-libs/core/src/util/command-query/query.service.ts
Server rendering
- Express engine
core-libs/setup/ssr/engine/ng-express-engine.ts - SSR decorator
core-libs/setup/ssr/engine-decorator/ng-express-engine-decorator.ts - Optimized SSR
core-libs/setup/ssr/optimized-engine/optimized-ssr-engine.ts - Rendering cache
core-libs/setup/ssr/optimized-engine/rendering-cache/rendering-cache.ts
Other components
- Shopper
- Commerce REST API
- Commerce CMS
Connections 17
- Shopper → Storefront app: uses
README.md - Storefront app → Commerce REST API: calls REST
README.md - Storefront app → Commerce CMS: fetches content
README.md - Storefront app → CMS pages: renders pages
- Shopper → Search: searches
README.md - Shopper → Product details: views products
README.md - Shopper → Cart: manages cart
README.md - Shopper → Checkout: checks out
README.md - Shopper → Order history: views orders
README.md - Checkout → Checkout query: uses query
- Checkout query → Query service: creates query
feature-libs/checkout/base/core/facade/checkout-query.service.ts - Checkout query → Cart: reads cart
feature-libs/checkout/base/core/facade/checkout-query.service.ts - Checkout query → Commerce REST API: loads details
- SSR decorator → Express engine: wraps engine
core-libs/setup/ssr/engine-decorator/ng-express-engine-decorator.ts - SSR decorator → Optimized SSR: enables optimization
core-libs/setup/ssr/engine-decorator/ng-express-engine-decorator.ts - Optimized SSR → Rendering cache: uses cache
core-libs/setup/ssr/optimized-engine/optimized-ssr-engine.ts - Express engine → Shopper: renders response