Building the FSA Spartacus Storefront using 2.0 Libraries

Note: Spartacus 3.x is no longer maintained. Please upgrade to the latest version.

Note: Spartacus 3.x was tested with SAP Commerce Cloud versions 1905 to 2105. Spartacus 3.x has not been verified to work with (and is not guaranteed to work with) SAP Commerce Cloud 2211 or later releases.

The following instructions describe how to build an FSA storefront application using published FSA Spartacus 2.x libraries. If you are building Spartacus from source, see Contributor Setup.

Table of Contents

• Prerequisites
  • Front-End Development Requirements
  • Back-End Server Requirements
  • Windows Setup
• Creating a New Angular App
• FSA Spartacus Project Setup
  • Installing Dependencies
  • Checking app.module.ts for base URL and Other Settings
  • Starting your Spartacus App

Prerequisites

Before carrying out the procedures below, ensure the following front-end and back-end requirements are in place.

Front-End Development Requirements

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: v1.15 or later.

Back-End Server Requirements

FSA Spartacus uses SAP Commerce and Financial Services Accelerator back end and makes use of the sample data.

• SAP Commerce version: Release 2011 (the latest patch is recommended - 2011.1).
• Financial Services Accelerator version: Release 2102 is required.

For more information, see Installing SAP Commerce Cloud FSA for use with FSA Spartacus.

Windows Setup

To successfully install the project in the Windows environment, first make sure that you have installed GitBash.

Next, create the .npmrc file at the root of your Angular project. The .npmrc file should contain the following:

shell = "{instalation directory}\\Git\\bin\\bash.exe" 
script-shell = "{instalation directory}\\Git\\bin\\bash.exe" 


Example:
shell = "C:\\Program Files\\Git\\bin\\bash.exe"
script-shell = "C:\\Program Files\\Git\\bin\\bash.exe"

Once you have configured this, you should execute all the commands in the procedures that follow from the GitBash console.

Creating a New Angular App

The following procedure describes how to create a new Angular application with the name mystore.

1. Open a terminal or command prompt window at the location of your choice.

2. Using the Angular CLI, generate a new Angular application with the following command:

   ng new mystore --style=scss
   

   When prompted for Angular routing, enter n for ‘no’.

   The mystore folder and the new app are created.

3. Access the newly created mystore folder with the following command:

     cd mystore
   

FSA Spartacus Project Setup

The easiest way to start a new project is to use Angular Schematics to set up your application quickly.

You can add FSA Spartacus libraries to your Spartacus Angular project by running the following command from your project root:

ng add @spartacus/fsa-schematics

For a detailed explanation, visit FSA Schematics.

For a full list of available parameters, please visit Spartacus schematics documentation.

Installing Dependencies

Install dependencies needed by your FSA Spartacus app with the following command:

yarn install

Checking app.module.ts for base URL and Other Settings

Open the src\app\app.module.ts file, and check for any changes you want to make for your setup.

After FSA is installed your app.module.ts should look like following:

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { StoreModule } from '@ngrx/store';
import { AppComponent } from './app.component';
import { FSStorefrontModule } from '@spartacus/fsa-storefront';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    FSStorefrontModule.withConfig({
      backend: {
        occ: {
          baseUrl: '/--path to the server---/',
          prefix: '/occ/v2/'
        }
      },
      context: {
        currency: ['EUR'],
        language: ['en', 'de'],
        urlParameters: ['baseSite', 'language', 'currency'],
        baseSite: ['financial']
      },
      authentication: {
        client_id: 'financial_customer',
        client_secret: 'secret'
      },
      features: {
        consignmentTracking: true,
      }
    })
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

For example, check:

• baseUrl: Points to your SAP Commerce server.
• prefix: Defines the prefix to OCC calls; change /rest/v2/ to /occ/v2/ if using release 2011.
• context: Defines the site context such as base site, language, and currency.
• authentication: Defines authorization of the financial customer.

Note: If your setup failed and for some reason your app.module.ts is not configured like described please check one more time requirements for fsa schematics usage - Angular CLI version should be > = 10.1!

Starting your Spartacus App

Start your app with the following command:

yarn start

Your app will be compiled and then started.

To display your storefront, assuming everything is installed locally, browse to http://localhost:4200. If you installed the Financial sample data with the financialstorefront extension, the FSA Spartacus storefront for Financial services should appear.

Note: If your storefront doesn’t appear, you probably have to accept a privacy certificate. To do so, browse to https://localhost:9002/occ/v2/financial/cms/pages, and then accept the privacy certificate. This step is necessary because your browser will block calls to the app which makes calls to localhost:9002, due to security settings. To see the browser message, right-click in your browser, select Inspect, then click Console.

Congratulations! You’ve built your first FSA Spartacus storefront.