Skip to main content

Create a JSS project for the latest versions of JSS and Sitecore

Abstract

Describes creating a JSS app for the latest version of JSS and Sitecore

The current version of JSS helps you create a JSS application for the newest version of Sitecore.

To develop a JSS application, you must have:

  • An operating system supported by Node (Mac, Windows, Linux).

  • Node. We recommend using the latest long-term support (LTS) release.

Note

To run a JSS application in production or develop using Sitecore data you must connect your application to a Sitecore instance with the Headless Services module.

Sitecore requires Windows, but the Sitecore instance does not have to be local. You can use a Sitecore instance installed in a virtual machine or on a remote server.

To create a JSS project:

  1. Install the JSS CLI:

    npm install -g @sitecore-jss/sitecore-jss-cli
  2. To create the JSS application, in a terminal, run the following command:

    jss create <your-app-name> <app-template-name>

    Replace <your-app-name> with the application name you want, and <app-template-name> with the name of the template.

    For example: jss create my-first-jss-app nextjs.

    Note

    This command scaffolds a JSS application based on the latest version of JSS templates regardless of the JSS CLI version because it pulls the template code from the master branch of the JSS repository. To create an application based on an older version of JSS and Sitecore, refer to Create a JSS app for an older version of Sitecore.

  3. Change the directory to your application folder:

    cd my-first-jss-app
  4. Start the development server:

    jss start

For framework-specific walkthroughs and more detailed guides, start with the guide for developing JSS applications.