Documentation

Read and search through all the Sitecore JSS documentation

Walkthrough: Using the JSS CLI to Get Started with JSS and Next.js

You can create a JSS Next.js application by using the JSS command-line tool (CLI).

When using this approach, you will need to perform additional steps to connect to a Sitecore instance.

We recommend this approach for Sitecore developers who use the code-first developer workflow or wish to evaluate the JSS developer experience without installing Sitecore.

TL;DR

To quickly scaffold a JSS Next.js application, run the following commands in a terminal:

npm install -g @sitecore-jss/sitecore-jss-cli
jss create my-first-jss-app nextjs
cd my-first-jss-app
jss start

Create your application

To create a JSS application, you must:

  1. Install Node.js.

  2. Install the JSS CLI:

   npm install -g @sitecore-jss/sitecore-jss-cli

To verify the successful installation of the JSS CLI and to see the list of commands availably globally, run jss --help.

  1. Run:
    jss create my-first-jss-app nextjs

The command will create the JSS Next.js application and install the required packages.

Run your application

To run your application:

  1. In the terminal, go to your application directory. For example: cd my-first-jss-app.

  2. Run jss start.

To see the full list of commands available for your application, run jss --help.

Connect to Sitecore

Deploying your code-first artifacts and content to Sitecore, WYSIWYG editing, and use of JSS in production will require a Sitecore instance.

Sitecore requires Windows, but the instance can be on a virtual machine or a remote server.

To connect your application to Sitecore, you must:

  1. Setup JSS Server Components.
  2. Deploy the application to a Sitecore environment.

Found a problem? Have something to add? Edit this on GitHub