Uniform Optimize starter kit for Sitecore JSS and Next.js

This repo contains both the starter kit with content items and required configuration files.

This kit is pre-wired for edge-side rendering and static site generation for Sitecore JSS and is created to fast track the activation of both Uniform Optimize and Deploy capabilities together with a Sitecore JSS solution.

You can also use this kit to start a vanilla project, simply remove everything from /src/components and adjust the Sitecore site name from uniform-jss-kit to whatever you want and get cracking.

Official docs

1. Uniform Optimize for Sitecore docs

Pre-requisites

1. Sitecore 9.3+ instance available with Sitecore JSS installed and configured.
2. "Uniform for Sitecore v5" installed and configured on your Sitecore instance. Check out these docs for more info.
3. Install the Sitecore package with the starter kit items from /sitecore/App_Data/packages folder (optional).
4. Create Sitecore API key as per Sitecore JSS documentation here.

Setup environment variables

1. Create an .env file next to package.json (see .env-example) and provide the values for your Sitecore instance:

   # the Sitecore endpoint where Uniform Connector is installed and configured
   UNIFORM_API_URL=https://sitecore.dev.local
   UNIFORM_API_TOKEN='Uniform API token, see the docs'
   UNIFORM_API_KEY: 'Sitecore API key value'
   

Getting started

1. Add NPM_TOKEN environment variable with the value we provided you with.
2. npm install
3. jss setup and follow the steps Sitecore JSS requires and use the API key you created during the Pre-requisites step above.
4. jss deploy config to deploy the application config from /sitecore/config folder into your Sitecore instance.
5. npm run build to build the app.
6. npm start to start the app in connected mode.
7. For development, use npm run dev command.

Cloudflare worker setup

1. Install @cloudflare/wrangler npm package
   npm i @cloudflare/[email protected] -g

2. Create a Cloudflare account: https://dash.cloudflare.com/login

3. Create a Cloudflare API token:

   • Follow the link: https://dash.cloudflare.com/profile/api-tokens
   • Select "Create Token" button
   • Select "Edit Cloudflare Workers" among API token templates
   • In a new "Create Token" window don't change any Permissions (they are predefined correctly); indicate "All Accounts" in Account Resources section and "All Zones" in Zone Resources section. Client IP Address Filtering section can be skipped.
   • Press "Continue To Summary" and then "Create Token" buttons.
   • IMPORTANT! Copy and save your API Token somewhere. It only shown once after the initial setup.
   • Finalize the worker setup: navigate to the Workers page (Click Workers link on the right pane on the Cloudflare main page) and click the Setup button next to your worker name; Choose to proceed with free account on the next page

4. Enable config: uniform-jss-kit.Uniform.Deployment.HostedService.Cloudflare.config.disabled and specify required variables:

   • update CF_ACCOUNT_ID with your Cloudflare account ID
   • update CF_API_TOKEN with created Cloudflare API token
   • update CF_WORKER_NAME with preferable worker name

5. Default Cloudflare worker domain: https://<WORKER-NAME>.<CLOUDFLARE-ACCOUNT-NAME>.workers.dev

Note: Remove or update the robots.txt if you going to use this kit in production