Install Starter Store

Introduction

Goal

Install the Starter Store boot application and connect it to your commerce backend.

Background

The Starter Store boot application is designed as an out-of-the-box accelerator to integrate your commerce backend with Bloomreach Experience Manager and Bloomreach Discovery.

By default, the boot application has the commercetools and Bloomreach Discovery backends configured. You can either use one of the available commerce backend configurations or create a new configuration for your commerce backend.

This page explains how to set up the boot application in your local development environment, connect your commerce backend, and deploy in a server environment.

Set Up Local Development Environment

The Starter Store boot application is available in the Bloomreach Experience Manager Enterprise Maven repository.

Log in at https://maven.onehippo.com/.

Point your browser to https://maven.onehippo.com/maven2-enterprise/com/bloomreach/commercedxp/starterstore-boot/.

Pick the appropriate release (version number of the format X.Y.Z) and open the corresponding folder.

Download the starterstore-boot-X.Y.Z-project.tar.gz (or .tar.bz2 or .zip) source distribution and extract it to a folder in your local environment.

Set the connection properties for your commerce backends in conf/hst.properties. Refer to the documentation of each commerce backend configuration for details. Example:

# Starter Store parameters for bloomreach backend service.
bloomreach.cache.enabled = false
bloomreach.account.id = 0000
bloomreach.api.base.url = http://brm-core-0.brsrvr.com/api/v1/core/
bloomreach.domain.key = domain_key_here

# Starter Store parameters for bloomreach_autosuggestions backend service.
bloomreach_autosuggestions.cache.enabled = true
bloomreach_autosuggestions.account.id = 0000
bloomreach_autosuggestions.api.base.url = http://brm-core-0.brsrvr.com/api/v1/core/
bloomreach_autosuggestions.domain.key = domain_key_here

# Starter Store parameters for commercetools backend service.
commercetools.cache.enabled = true
commercetools.baseUrl = https://api.sphere.io/project-name-here/
commercetools.accessTokenUri = https://auth.sphere.io/oauth/token?grant_type=client_credentials&scope=manage_project:project-name-here
commercetools.clientId = client_id_here
commercetools.clientSecret = client_secret_here
commercetools.username = [email protected]
commercetools.password = secret

Build the application using Maven:

mvn clean verify

Run the application:

mvn -P cargo.run

Verify that the Bloomreach Experience Manager CMS application is accessible at http://localhost:8080/cms/ (login with credentials admin/admin).

To verify that your commerce backend connection is working properly, navigate to the Content perspective and browse to Starter Store Boot Project > products. Open one of the example product documents or create a new one, make sure your commerce backend is selected under Commerce Connector, then click Browse under Related External Product. You should be able to browse the products in the commerce backend.

Deploy in a Server Environment

The deployment process for the Starter Store boot application is the same as for any Bloomreach Experience Manager implementation project.

If you are deploying in Bloomreach Cloud, follow the instructions in Deploy in Bloomreach Cloud.

Otherwise, follow the instructions in Create a Project Distribution and Deploy a Project Distribution.