Merge pull request #129 from Sitecore/develop

Helix Examples Release #6

Author: nickwesselman

docs/examples/helix-basic-company.md

@@ -23,10 +23,6 @@ the site.
 it likely would not merit application of Sitecore Helix practices, or perhaps would be
 implemented as a single Project-layer module.*
 
-The customer is also utilizing a third-party agency for the website front-end implementation,
-and thus HTML, CSS, and JS are being provided by an external team with no knowledge of
-Sitecore or Sitecore Helix practices.
-
 ## Implementations
 
 ### [Helix Basic Company - ASP.NET Core and Sitecore Content Serialization](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-aspnetcore)
@@ -38,6 +34,17 @@ This is a [ASP.NET Core Rendering SDK](https://doc.sitecore.com/developers/100/d
 * [Helix Publishing Pipeline](https://github.com/richardszalay/helix-publishing-pipeline) is used for building and deploying code for CM/CD, and is configured to auto-deploy on build.
 * The Rendering Host projects do not need Helix Publishing Pipeline, because ASP.NET Core / SDK-style projects support sharing content assets.
 
+### [Helix Basic Company - Next.js and Sitecore Content Serialization](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-nextjs)
+
+This is a [Sitecore JSS / Next.js](https://jss.sitecore.com/docs/nextjs/introduction/why-nextjs) and [Sitecore Content Serialization](https://doc.sitecore.com/developers/100/developer-tools/en/sitecore-content-serialization.html) based implementation of Helix Basic Company.
+* The site is rendered in an independently-running rendering host, built with Next.js.
+* The JavaScript/Next.js solution is intentionally kept in the Project layer, in its entirety, without using Helix semantics, as to not require Sitecore solution architecture in front-end code.
+* The JSS project is configured for a _Sitecore-first_ workflow. It uses serialized items and not JSS _code-first_ deployment.
+  * For mocking of Sitecore data, it uses [Storybook](https://storybook.js.org/) instead.
+* This solution avoids the need for back-end Sitecore code through use of GraphQL to obtain additional data. Thus the Visual Studio solution is rather sparse. It could be argued that this could be further simplified in a real-world solution.
+* Items are serialized using the Sitecore CLI.
+* [Helix Publishing Pipeline](https://github.com/richardszalay/helix-publishing-pipeline) is used for building and deploying code for CM/CD, and is configured to auto-deploy on build.
+
 ### [Helix Basic Company - TDS](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-tds)
 
 This is a [Sitecore TDS](https://www.teamdevelopmentforsitecore.com/TDS-Classic)-based

docs/install.md

@@ -18,6 +18,7 @@ instance.
 1. [Clone the full repository](https://github.com/Sitecore/Helix.Examples) or [download it](https://github.com/Sitecore/Helix.Examples/archive/master.zip) and unzip into a local directory.
 1. Follow the `README.md` instructions for each example.
    1. [Helix Basic Company - ASP.NET Core](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-aspnetcore/README.md)
+   1. [Helix Basic Company - Next.js](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-nextjs/README.md)
    1. [Helix Basic Company - TDS](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-tds/README.md)
    1. [Helix Basic Company - TDS Consolidated](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-tds-consolidated/README.md)
    1. [Helix Basic Company - Unicorn](https://github.com/Sitecore/Helix.Examples/tree/master/examples/helix-basic-unicorn/README.md)

examples/helix-basic-aspnetcore/.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "sitecore.cli": {
-      "version": "2.0.0",
+      "version": "3.0.0",
       "commands": [
         "sitecore"
       ]

examples/helix-basic-aspnetcore/.env

@@ -3,7 +3,7 @@ REGISTRY=
 VERSION=
 
 NETCORE_BUILD_IMAGE=mcr.microsoft.com/dotnet/core/sdk:3.1
-SOLUTION_BUILD_IMAGE=mcr.microsoft.com/dotnet/framework/sdk:4.8
+SOLUTION_BUILD_IMAGE=mcr.microsoft.com/dotnet/framework/sdk:4.8-windowsservercore-ltsc2019
 SOLUTION_BASE_IMAGE=mcr.microsoft.com/windows/nanoserver:1809
 BUILD_CONFIGURATION=debug
 
@@ -14,15 +14,15 @@ HOST_LICENSE_FOLDER=
 CD_HOST=cd.basic-company-aspnetcore.localhost
 CM_HOST=cm.basic-company-aspnetcore.localhost
 ID_HOST=id.basic-company-aspnetcore.localhost
-SITE_HOST=www.basic-company-aspnetcore.localhost
+RENDERING_HOST=www.basic-company-aspnetcore.localhost
 
 SITECORE_DOCKER_REGISTRY=scr.sitecore.com/sxp/
 SITECORE_MODULE_REGISTRY=scr.sitecore.com/sxp/modules/
 SITECORE_TOOLS_REGISTRY=scr.sitecore.com/tools/
-SITECORE_VERSION=10.0-ltsc2019
-HEADLESS_SERVICES_VERSION=15.0.1-1809
-MANAGEMENT_SERVICES_VERSION=2.0.0-1809
-TOOLS_VERSION=10.0.0-1809
+SITECORE_VERSION=10.1-ltsc2019
+HEADLESS_SERVICES_VERSION=18.0-1809
+MANAGEMENT_SERVICES_VERSION=3.0-1809
+TOOLS_VERSION=10.1-1809
 
 SITECORE_ADMIN_PASSWORD=
 SQL_SA_PASSWORD=
@@ -36,4 +36,5 @@ SITECORE_ID_CERTIFICATE_PASSWORD=
 SITECORE_LICENSE=
 TRAEFIK_IMAGE=traefik:v2.2.0-windowsservercore-1809
 TRAEFIK_ISOLATION=hyperv
-ISOLATION=default
+ISOLATION=default
+MEDIA_REQUEST_PROTECTION_SHARED_SECRET=

examples/helix-basic-aspnetcore/.gitignore

@@ -31,6 +31,9 @@ _ReSharper*/
 # may contain OAuth secrets, do not commit
 .sitecore/user.json
 
+# NuGet cache for Sitecore CLI
+.sitecore/package-cache/
+
 # Ephemeral index caches used by serialization, do not commit
 .scindex
 

examples/helix-basic-aspnetcore/Packages.props

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
-    <PlatformVersion>10.0.0</PlatformVersion>
-    <SitecoreAspNetVersion>15.0.1</SitecoreAspNetVersion>
+    <PlatformVersion>10.1.0</PlatformVersion>
+    <SitecoreAspNetVersion>16.0.0</SitecoreAspNetVersion>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Update="Sitecore.Nexus" Version="$(PlatformVersion)" />

examples/helix-basic-aspnetcore/docker-compose.override.yml

@@ -40,15 +40,14 @@ services:
       ASPNETCORE_ENVIRONMENT: "Development"
       ASPNETCORE_URLS: "http://*:80"
       Sitecore__InstanceUri: "http://cd"
-      Sitecore__RenderingHostUri: "https://${SITE_HOST}"
       Sitecore__EnableExperienceEditor: "true"
     depends_on:
       - solution
       - cd
     labels:
       - "traefik.enable=true"
       - "traefik.http.routers.rendering-secure.entrypoints=websecure"
-      - "traefik.http.routers.rendering-secure.rule=Host(`${SITE_HOST}`)"
+      - "traefik.http.routers.rendering-secure.rule=Host(`${RENDERING_HOST}`)"
       - "traefik.http.routers.rendering-secure.tls=true"
 
   traefik:
@@ -70,21 +69,25 @@ services:
       context: ./docker/build/mssql
       args:
         BASE_IMAGE: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-mssql:${SITECORE_VERSION}
-        HEADLESS_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}jss-xm1-assets:${HEADLESS_SERVICES_VERSION}
+        HEADLESS_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}sitecore-headless-services-xm1-assets:${HEADLESS_SERVICES_VERSION}
     mem_limit: 2GB
     volumes:
       - ${LOCAL_DATA_PATH}\mssql:c:\data
 
+  # Mount our Solr data folder.
   solr:
-    image: ${REGISTRY}${COMPOSE_PROJECT_NAME}-xm1-solr:${VERSION:-latest}
-    build:
-      context: ./docker/build/solr
-      args:
-        BASE_IMAGE: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-solr:${SITECORE_VERSION}
-    mem_limit: 1GB
     volumes:
       - ${LOCAL_DATA_PATH}\solr:c:\data
 
+  # Mount our Solr data folder and use our retagged Solr image.
+  # Some modules (like SXA) also require additions to the Solr image.
+  solr-init:
+    image: ${REGISTRY}${COMPOSE_PROJECT_NAME}-xm1-solr-init:${VERSION:-latest}
+    build:
+      context: ./docker/build/solr-init
+      args:
+        BASE_IMAGE: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-solr-init:${SITECORE_VERSION}
+
   id:
     image: ${REGISTRY}${COMPOSE_PROJECT_NAME}-id:${VERSION:-latest}
     build:
@@ -102,7 +105,7 @@ services:
       context: ./docker/build/cd
       args:
         BASE_IMAGE: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-cd:${SITECORE_VERSION}
-        HEADLESS_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}jss-xm1-assets:${HEADLESS_SERVICES_VERSION}
+        HEADLESS_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}sitecore-headless-services-xm1-assets:${HEADLESS_SERVICES_VERSION}
         TOOLING_IMAGE: ${SITECORE_TOOLS_REGISTRY}sitecore-docker-tools-assets:${TOOLS_VERSION}
         SOLUTION_IMAGE: ${REGISTRY}${COMPOSE_PROJECT_NAME}-solution:${VERSION:-latest}
     depends_on:
@@ -113,6 +116,8 @@ services:
       - ${HOST_LICENSE_FOLDER}:C:\license
     environment:
       SITECORE_LICENSE_LOCATION: C:\license\license.xml
+      ## Development Environment Optimizations
+      SITECORE_DEVELOPMENT_PATCHES: DevEnvOn,CustomErrorsOff,DebugOn,DiagnosticsOff,InitMessagesOff
     entrypoint: powershell -Command "& C:\tools\entrypoints\iis\Development.ps1"
 
   cm:
@@ -121,7 +126,7 @@ services:
       context: ./docker/build/cm
       args:
         BASE_IMAGE: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-cm:${SITECORE_VERSION}
-        HEADLESS_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}jss-xm1-assets:${HEADLESS_SERVICES_VERSION}
+        HEADLESS_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}sitecore-headless-services-xm1-assets:${HEADLESS_SERVICES_VERSION}
         MANAGEMENT_SERVICES_IMAGE: ${SITECORE_MODULE_REGISTRY}sitecore-management-services-xm1-assets:${MANAGEMENT_SERVICES_VERSION}
         TOOLING_IMAGE: ${SITECORE_TOOLS_REGISTRY}sitecore-docker-tools-assets:${TOOLS_VERSION}
         SOLUTION_IMAGE: ${REGISTRY}${COMPOSE_PROJECT_NAME}-solution:${VERSION:-latest}
@@ -133,4 +138,8 @@ services:
       - ${HOST_LICENSE_FOLDER}:C:\license
     environment:
       SITECORE_LICENSE_LOCATION: C:\license\license.xml
+      RENDERING_HOST_PUBLIC_URI: "https://${RENDERING_HOST}"
+      ## Development Environment Optimizations
+      SITECORE_DEVELOPMENT_PATCHES: DevEnvOn,CustomErrorsOff,DebugOn,DiagnosticsOff,InitMessagesOff
+      Sitecore_AppSettings_exmEnabled:define: "no" # remove to turn on EXM
     entrypoint: powershell -Command "& C:\tools\entrypoints\iis\Development.ps1"

examples/helix-basic-aspnetcore/docker-compose.yml

@@ -45,13 +45,24 @@ services:
         target: c:\data
   solr:
     isolation: ${ISOLATION}
+    image: ${SITECORE_DOCKER_REGISTRY}nonproduction/solr:8.4.0-${SITECORE_VERSION}
     ports:
       - "8984:8983"
-    image: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-solr:${SITECORE_VERSION}
     volumes:
       - type: bind
         source: .\solr-data
         target: c:\data
+    environment:
+      SOLR_MODE: solrcloud
+  solr-init:
+    isolation: ${ISOLATION}
+    image: ${SITECORE_DOCKER_REGISTRY}sitecore-xm1-solr-init:${SITECORE_VERSION}
+    environment:
+      SITECORE_SOLR_CONNECTION_STRING: http://solr:8983/solr
+      SOLR_CORE_PREFIX_NAME: ${SOLR_CORE_PREFIX_NAME}
+    depends_on:
+      solr:
+        condition: service_healthy
   id:
     isolation: ${ISOLATION}
     image: ${SITECORE_DOCKER_REGISTRY}sitecore-id:${SITECORE_VERSION}
@@ -81,7 +92,7 @@ services:
     depends_on:
       mssql:
         condition: service_healthy
-      solr:
+      solr-init:
         condition: service_started
       redis:
         condition: service_started
@@ -90,10 +101,11 @@ services:
       Sitecore_ConnectionStrings_Security: Data Source=mssql;Initial Catalog=Sitecore.Core;User ID=sa;Password=${SQL_SA_PASSWORD}
       Sitecore_ConnectionStrings_Web: Data Source=mssql;Initial Catalog=Sitecore.Web;User ID=sa;Password=${SQL_SA_PASSWORD}
       Sitecore_ConnectionStrings_ExperienceForms: Data Source=mssql;Initial Catalog=Sitecore.ExperienceForms;User ID=sa;Password=${SQL_SA_PASSWORD}
-      Sitecore_ConnectionStrings_Solr.Search: http://solr:8983/solr
+      Sitecore_ConnectionStrings_Solr.Search: http://solr:8983/solr;solrCloud=true
       Sitecore_ConnectionStrings_Redis.Sessions: redis:6379,ssl=False,abortConnect=False
       Sitecore_License: ${SITECORE_LICENSE}
       SOLR_CORE_PREFIX_NAME: ${SOLR_CORE_PREFIX_NAME}
+      MEDIA_REQUEST_PROTECTION_SHARED_SECRET: ${MEDIA_REQUEST_PROTECTION_SHARED_SECRET}
     healthcheck:
       test: ["CMD", "powershell", "-command", "C:/Healthchecks/Healthcheck.ps1"]
       timeout: 300s
@@ -108,7 +120,7 @@ services:
     depends_on:
       mssql:
         condition: service_healthy
-      solr:
+      solr-init:
         condition: service_started
       id:
         condition: service_started
@@ -119,7 +131,7 @@ services:
       Sitecore_ConnectionStrings_Master: Data Source=mssql;Initial Catalog=Sitecore.Master;User ID=sa;Password=${SQL_SA_PASSWORD}
       Sitecore_ConnectionStrings_Web: Data Source=mssql;Initial Catalog=Sitecore.Web;User ID=sa;Password=${SQL_SA_PASSWORD}
       Sitecore_ConnectionStrings_ExperienceForms: Data Source=mssql;Initial Catalog=Sitecore.ExperienceForms;User ID=sa;Password=${SQL_SA_PASSWORD}
-      Sitecore_ConnectionStrings_Solr.Search: http://solr:8983/solr
+      Sitecore_ConnectionStrings_Solr.Search: http://solr:8983/solr;solrCloud=true
       Sitecore_ConnectionStrings_Sitecoreidentity.secret: ${SITECORE_IDSECRET}
       Sitecore_AppSettings_Telerik.AsyncUpload.ConfigurationEncryptionKey: ${TELERIK_ENCRYPTION_KEY}
       Sitecore_AppSettings_Telerik.Upload.ConfigurationHashKey: ${TELERIK_ENCRYPTION_KEY}
@@ -130,6 +142,7 @@ services:
       Sitecore_Identity_Server_CallbackAuthority: https://${CM_HOST}
       Sitecore_Identity_Server_Require_Https: "false"
       SOLR_CORE_PREFIX_NAME: ${SOLR_CORE_PREFIX_NAME}
+      MEDIA_REQUEST_PROTECTION_SHARED_SECRET: ${MEDIA_REQUEST_PROTECTION_SHARED_SECRET}
     healthcheck:
       test: ["CMD", "powershell", "-command", "C:/Healthchecks/Healthcheck.ps1"]
       timeout: 300s

examples/helix-basic-aspnetcore/docker/build/dotnetsdk/Dockerfile

@@ -10,6 +10,7 @@ ARG NETCORE_BUILD_IMAGE
 
 FROM ${NETCORE_BUILD_IMAGE} as netcore-sdk
 FROM ${BUILD_IMAGE}
+SHELL ["powershell", "-Command", "$ErrorActionPreference = 'Stop'; $ProgressPreference = 'SilentlyContinue';"]
 
 # Ensure updated nuget. Depending on your Windows version, dotnet/framework/sdk:4.8 tag may provide an outdated client.
 # See https://github.com/microsoft/dotnet-framework-docker/blob/1c3dd6638c6b827b81ffb13386b924f6dcdee533/4.8/sdk/windowsservercore-ltsc2019/Dockerfile#L7