uniformdev / sitecore-jss-nextjs-starterkit

Jamstack for Sitecore JSS using Next.js with Uniform SDK

Uniform - Sitecore JSS - Next.js starter kit

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

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.

Docs

1. Tutorial for Deploy part of this starter kit

2. Uniform for Sitecore docs

Pre-requisites

1. Sitecore 9.x-10.x instance available with Sitecore JSS installed and configured
2. "Uniform for Sitecore" installed and configured on your Sitecore instance. Check out the docs.
3. Install the Sitecore package with items from /sitecore/App_Data/packages folder.

Getting started with the app

Check out official docs for more scenarios and tutorial.

TL;DR version

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. Configure .env file according to your environment specifics (see .env-example file).
6. npm run build to build the app.
7. npm run dev to start development server.
8. npm start to start the app in connected mode.
9. npm run export to run static export.

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

sitecore-jss-nextjs-starterkit's Issues

Build errors due to typescript

Can you please specify the correct versions of react, react-dom and types/react, types/react-dom to be used in sitecore JSS NextJs project, we are facing issues currently with Vercel build.

npm script `deploy` conflicts with `jss deploy` command

The deploy script defined in package.json prevents jss deploy from running as the JSS CLI gives precedence to commands defined in package.json. Therefore, running jss deploy in this case is the equivalent of npm run deploy.

Theoretically, this seems like something that should be changed in the JSS CLI, but we can work around it by renaming our deploy script.