01. Getting Started

Important Note

Visual Studio 2015 is required for this solution. Installing Visual Studio 2017 alongside will cause issues with .NET Core dependencies and will prevent the solution from deploying correctly

Prerequisites

Please note the Sitecore Commerce prerequisites on the following page particularly the ASP.NET related prerequisites

Please note the Habitat prerequisites

Installation video

This 15 mins video takes you through the installation process to show you the overall process. Please read through the steps below to understand the detailed process before commencing.

Defaults

We highly recommend changing the default password in the /install-commerce-config.json file as the user will be created with administrative privileges

The automated setup scripts assume the following default settings and locations:

Setting	Default Value
Habitat Project location	c:\projects\habitat\
Commerce Project location	c:\projects\sitecore.demo.retail\
Habitat Site domain	habitat.dev.local
Commerce Site domain	retail.dev.local
Sitecore Website location	c:\websites\habitat.dev.local\
Database server	.
Location of Sitecore Commerce setup .exe	C:\Projects\Sitecore.Demo.Retail\Install
Windows User Account (automatically created)	HabitatRunTimeUser
Windows User Password	pass@word1
Commerce Engine Url	http://habitat.commerceengine.dev.local:5000/
Commerce Server Services Url	http://habitat.csservices.dev.local:1004/

Commerce Server Setup package can be downloaded from here

If you do not want to use the default settings, you need to adjust the appropriate values in the following files:

/src/Project/Retail/code/App_Config/Include/zzz/z.Sitecore.Demo.Retail.DevSettings.config
/gulp-config.js
/publishsettings.targets
/install-commerce-config.json

Some defaults might require changes to Sitecore items and other files. Please refer to the Sitecore and Sitecore Commerce documentation for more information.

Installing the Sitecore Commerce Demo

To install:

1. Ensure you have the latest version of PowerShell (5.1) installed.
2. Clone this repository to your local file system in the Commerce Project location above, e.g. c:\projects\Sitecore.Demo.Retail
3. Clone the Habitat to your local file system under the Habitat Project location above, e.g. c:\projects\Habitat
4. Install Commerce Server:
   • From the Sitecore Commerce 8.2.1 download copy CommerceServer-11.4.148.exe to c:\projects\sitecore.demo.retail\Install\
   • Open a PowerShell prompt with elevated privileges and run .\\install-commerce-server.ps1 in the root of your clone of this repository.
     • On some systems, the Carbon PowerShell module does not get installed automatically. In that case you can get it from here.
   • Alternatively:
     • Open Visual Studio 2015 in Administrator Mode
     • Open the Visual Studio 2015 Task Runner Explorer pane (View | Other Windows | Task Runner Explorer).
     • Switch to "Solution 'Sitecore.Demo.Retail'"
     • Run the "CE-Install-Commerce-Server" task
5. Install Sitecore
   • SIM Solution Installation
     • If you have access to the Sitecore821_Commerce821 SIM Solution, import the Solution using SIM and move on to Step 6
   • Traditional Installation

     • Install Sitecore 8.2 update 1 in the Commerce Website location above with IIS bindings for Commerce Site domain and Habitat Site domain

       • This step can also be done with SIM, when doing so ensure these settings:

         • Note: To get alignment in database naming, modify advanced setting patternCore/SqlServer/DatabaseNamePattern to be {SqlPrefix}.{DatabaseRole}

         Setting	Value
         Site name	habitat.dev.local
         Host name	habitat.dev.local
         SQL Prefix	demo.local_Sitecore
         Location	c:\websites\habitat.dev.local\

     • Install the following Sitecore Experience Platform packages:

       • Webforms for Marketers
       • Email Experience Manager
       • Experience Generator
       • Email Experience Generator

     • Install the following Sitecore Commerce 8.2.1 packages (which can be found as part of the Sitecore Commerce 8.2.1 download).

       • Sitecore Commerce Connect 10.0.174.zip
       • Sitecore Commerce Server Connect.10.0.70.update
       • Sitecore.Commerce.Engine.Connect.1.0.2301.update
       • Sitecore Commerce Business Tools Shared.1.0.100.update
       • Sitecore Commerce Customer and Order Manager.1.0.51.update
       • Sitecore Commerce Merchandising Manager.10.0.294.update
       • Sitecore Commerce Pricing and Promotion Manager.1.0.75.update
6. Install Habitat using the installation guide in the Habitat Wiki
7. Install the Sitecore.Demo.Retail Sitecore solution
   • Open a command prompt on the Commerce Project location above, e.g. c:\projects\Sitecore.Demo.Retail
   • Run npm install to install the required node.js dependencies
   • Run gulp to execute the build and deployment script for the Sitecore website
   • In case the last step, the Unicorn synchronization, fails, go to http://habitat.dev.local/unicorn.aspx?verb=Sync to run the synchronization manually.
8. Install Commerce Sites
   • Open a PowerShell prompt with elevated privileges and run .\\install-commerce-sites.ps1 in the root of repository.
   • Alternatively:
     • Open Visual Studio 2015 in Administrator Mode
     • Open the Visual Studio 2015 Task Runner Explorer pane (View | Other Windows | Task Runner Explorer).
     • Switch to "Solution 'Sitecore.Demo.Retail'"
     • Run the "CE-Install-Commerce-Sites" task
9. Re-index the product data
   • Log into Sitecore on http://retail.dev.local/sitecore
   • Open the Control Panel and open the Indexing Manager
   • Rebuild the sitecore_master_index
10. Visit the site on the Commerce Site domain: http://retail.dev.local.
11. Restrict rights on the computer for the automatically created user account (default : HabitatRuntimeUser)
    • We recommend setting Local security policy to Deny log on through Remote Desktop Services and Deny log on locally to the HabitatRuntimeUser.

For a reference storefront solution, please refer to the Sitecore Reference Storefront.