HabitatHome Demo and the tools and processes in it is a Sitecore® solution example built using Sitecore Experience Accelerator™ (SXA) on Sitecore Experience Platform™ (XP) following the Helix architecture principles.
Please read the LICENSE carefully prior to using the code in this repository
The code, samples and/or solutions provided in this repository are unsupported by Sitecore PSS. Support is provided on a best-effort basis via GitHub issues or Slack #habitathome (see end of README for additional information).
It is assumed that you already have a working instance of Sitecore XP and all prerequisites prior to installing the demo. Support for product installation issues should be directed to relevant Community channels or through regular Sitecore support channels.
The code, samples and/or solutions provided in this repository are for example purposes only and without warranty (expressed or implied). The code has not been extensively tested and is not guaranteed to be bug free.
Prior to attempting the demo installation, ensure you have a working Sitecore XP 9.0.1 instance. Detailed installation instructions can be found at doc.sitecore.com.
In addition to a base XP 9.0.1 installation, the following modules are required:
- Sitecore PowerShell Extensions 4.7.2 for Sitecore 8/9 on Marketplace
- Sitecore Experience Accelerator for 9.0 version 1.6 on dev.sitecore.com
- Data Exchange Framework v2.0.1 on dev.sitecore.com as well as relevant Providers on same page
- Data Exchange Framework 2.0.1 Dynamics Connectors on dev.sitecore.com
- Url Rewrite 2.1
- Can be installed using Web Platform Installer in IIS Manager
The demo is configured for HTTPS/SSL. Please ensure that you create an HTTPS binding with appropriate self-signed certificates.
In order to deploy the assets, you need either Visual Studio 2017 or MSBuild Tools for Visual Studio 2017.
Node.JS is also required
The following is a list of default values / assumptions for install locations
Project location c:\projects\sitecore.habitathome.content\
Habitat Site domain habitathome.dev.local
Web Root c:\inetpub\wwwroot
Host Suffix dev.local
xConnectRoot habitat_xconnect.dev.local
If you do not use habitathome.dev.local you will need to modify the Host Name in
/sitecore/content/Habitat Sites/Habitat Home/Settings/Site Grouping/Habitat Home
after successfully deploying the site.
The Habitat Home site will not respond / render correctly until this value is modified.
If you do not want to use the default settings, you need to adjust the appropriate values in the following files:
/gulp-config.js
/publishsettings.targets
src\Project\Common\code\App_Config\Include\Project\z.Common.Website.DevSettings.config
All installation instructions assume using PowerShell 5.1 in administrative mode.
- Before cloning, you need to configure git to allow long paths, which is not the default.
git config --system core.longpaths true
Clone the Sitecore.HabitatHome.Content repository locally - defaults are configured for C:\Projects\Sitecore.HabitatHome.Content.
- Clone
-- https:
git clone https://github.com/Sitecore/Sitecore.HabitatHome.Content.git
-- ssh:git clone [email protected]:Sitecore/Sitecore.HabitatHome.Content.git
From the root of the solution
- Run
npm install
if you plan on installing the Commerce (XC) demo:
- Run
.\node_modules\.bin\gulp quick-deploy
if you are only installing this demo:
- Run
.\node_modules\.bin\gulp
An error (maxBuffer) sometimes occurs the first time running gulp during Sync-Unicorn. Running gulp a second time resolves the issue (and doesn't take as long)
if using Visual Studio task runner, please see this workaround
- Browse to https://habitathome.dev.local (or whatever hostname you selected)
- You should see the Habitat Home landing page with a full-width carousel
- If you do not see the full-width carousel and instead see the initial Sitecore default landing page, ensure that your Host Name was configured correctly in
/sitecore/content/Habitat Sites/Habitat Home/Settings/Site Grouping/Habitat Home
- Browse to https://habitat.dev.local
- You should see the Habitat landing page (not Habitat Home)
Please post any issues on Slack Community #habitathome channel or create an issue on GitHub. Contributions are always welcome!