Using Kajoo XM Cloud starter templates

This document focuses on integrating Kajoo with Sitecore Cloud XM, utilizing the Kajoo XM Cloud foundation templates.

Kajoo provides two template GitHub repositories to help you quickly start with XM Cloud using Kajoo.

Kajoo template for Sitecore XM Cloud

The Kajoo template for XM Cloud is based on the Sitecore XM Cloud starter template available at https://github.com/sitecorelabs/xmcloud-foundation-head with Kajoo plugin added on top of it. This template can be employed to deploy the Sitecore Management role (CM) in XM Cloud environment with preconfigured Kajoo integration.

How to Use This Template

If don’t have XM Cloud repository

  1. Visit the Kajoo foundation template for XM Cloud repository page in GitHub

  2. Choose ‘Create a new repository’ under the ‘Use this template’ menu in the top right corner:

    image-20240109-235444.png
  3. Follow the instructions outlined in the README.md file for further guidance.

Note: you can also Mirror or Fork the repository to your own repository.


If you have existing XM Cloud repository

  1. Visit the Kajoo foundation template for XM Cloud repository page in GitHub

  2. Inspect the differences between the repository and the Sitecore foundation repository

    image-20240110-001509.png
  3. Manually apply the differential changes to your existing XM Cloud repository

 

Kajoo template for Headless SXA

The Kajoo template for Headless SXA is based on the Sitecore Jss NextJS starter template with SXA and multisite initializers, specifically crafted to seamlessly work with Kajoo.

How to use Kajoo XM Cloud Template

  1. Visit the Kajoo SXA template for XM Cloud repository page in GitHub

  2. Choose ‘Create a new repository’ under the ‘Use this template’ menu in the top right corner:

  3. Ensure the application name in the 'package.json' file aligns with your JSS application name.

  4. Refer to the official Sitecore documentation for step-by-step instructions on creating a SXA headless site: https://doc.sitecore.com/xmc/en/developers/xm-cloud/create-a-headless-site-collection-and-site.html

  5. Confirm that the application name set in the rendering host precisely matches the application name

Kajoo relies on the Import Service and the JSS Manifest API to deploy the components and templates generated in Kajoo into your XM Cloud.

Due to technical limitations in XM Cloud, the JSS import user does not have read and write permissions by default. Before deploying your Kajoo-generated JSS application into your Sitecore XM Cloud environment, you must configure the access permissions for the JSS import user.

For information on how to configure the access permissions to the JSS import user, please visit Sitecore’s official documentation at Walkthrough: Connecting a code-first JSS Next.js application to XM Cloud.