Skip to main content

JSS / Sitecore Headless Services setup on Sitecore XP 10.3

 

Introduction :

Sitecore JavaScript Services is a toolkit for JavaScript developers allowing to build full-fledged customer solutions (SPAs, web apps, websites) using modern JS libraries and frameworks (React.is, Angular) by being completely unplugged from Sitecore.


Install Sitecore JSS Service:

Installation of Sitecore JSS Service is a breeze, especially if you've had experience installing packages in Sitecore before.


Prerequisites:

  1. Valid Sitecore JSS License: To confirm if you possess a valid license, you can check your license.xml file for the presence of 'Sitecore.JSS.'
  2. Sitecore Version: For certain features like the JavaScript Rendering SDKs, such as Next.js, you'll require Sitecore 9.0 Update-1 or a later version. If you intend to leverage these features, it's recommended to have Sitecore newer version installed. In this blog post I am using Sitecore 10.3 Update-1.

To install the JSS, make sure to follow the steps outlined below:

Step 1: 

Navigate to Sitecore Headless Rendering 21.0.1 and download the Sitecore Headless Services for Sitecore XP package.


Step 2:


After downloading the package, access Sitecore and navigate to the Desktop. From there, open the Development Tools and select the Installation Wizard. Once the Installation Wizard is loaded, proceed to install the downloaded package file. During the installation process, you'll be prompted to accept the terms and conditions ,accept and click on next then on Install.


once installed open content editor and right click on content then click on insert and you will be able to see Headless Tenant option.




Step 3: Application Setup


  1. Install latest Node.js ,I am using Node JS v20.6.1
  2. Launch Windows PowerShell, Navigate to Your Project Directory 
  3. Use the `cd` command to move to the directory where you plan to initiate your project. For instance:  cd C:\Sitecore10\10.3\SitecoreJSS
  4. Install the Sitecore JSS CLI - Execute the following command to globally install the Sitecore JSS CLI: npm install -g @sitecore-jss/sitecore-jss-cli
  5. After the installation process is complete, type `jss --help` in the PowerShell terminal. You should see an output resembling the following, indicating that the Sitecore JSS CLI is correctly installed and operational.


Environment setup is done I will create a project in my next blog.





Thanks for Reading!!








Comments

Popular posts from this blog

Step by step guide to Establish Headless SXA Tenant, Site and Next.js app with Sitecore XP 10.3

  Step 1: Prerequisites Installed Sitecore version 10.3  Check out Sitecore XP 10.3 Installation guide Configured an HTTP binding in IIS for your site (e.g., http://demo.dev.local - Next.js requires specific setup to connect to an HTTPS server) Installed Sitecore Powershell Installed Sitecore Headless Services  Checkout Headless Services Installation guide Installed SXA 10.3 Successfully populated Solr schema and built necessary indexes Ensured that you are running the latest version of Node Step 2: Create a Headless Tenant Go to the Sitecore Launchpad and click on ' Content Editor' button. To create a Headless Tenant, right-click on the ' sitecore\content ' and then choose ' Insert ' > ' Headless Tenant '. Input the Tenant Name (for eg, 'HeadlessSXATenant'), choose all modules , and then click ' OK '. To create a Headless Site, right-click on ' sitecore\content\HeadlessSXATenant ' and then select ' Insert' > '...

Troubleshooting Sitecore 10.3 XP Headless SXA Next.js : Handling No component rendering/Missing 'sxa-header' Placeholder in Partial Designs

The issue I encountered In my scenario, I created a partial design named " Header " which generated a Signature " header " and a Placeholder Item  named "Header" with the Placeholder Key " sxa-header ".  I integrated partial design into the  page design , and linked this page design to my  home  page. However, when I tried to access my home page in the Experience Editor, I observed that no components were rendering. Note : When creating a partial design, it should automatically generate the associated placeholder items. These items will bear placeholder keys prefixed with "sxa," resulting in names like "sxa-<<signature name>>." Cause The value in the Layout service configuration within the site settings (sxa-jss) does not align with the layoutServiceConfiguration value in Sitecore.JavaScriptServices.Apps.config (jss). To verify both the values please follow below steps: Navigate to /sitecore/content/[Tenant Name...

How to Add Sitecore's NuGet Repository To Visual Studio

Sitecore maintains its NuGet repository at https://sitecore.myget.org/gallery/sc-packages . To include Sitecore packages in Visual Studio , you must add this repository to your package sources. Step-by-step instructions: 1. Launch Visual Studio. 2. Open the " Tools " menu and select " Options ." 3. In the left navigation tree, find " NuGet Package Manager ," then choose " Package Sources. " 4. Click the plus icon located at the top-right corner. 5. In the dialog, you can define the name and source for the new package source. 6. Assign a Name, like " Sitecore NuGet ," for identification. 7. For Source, input the URL: https://sitecore.myget.org/F/sc-packages/api/v3/index.json . Thanks for Reading !