Welcome to Sitecore JSS

Thanks for using JSS!! Here are some resources to get you started:

Documentation

The official JSS documentation can help you with any JSS task from getting started to advanced techniques.

Styleguide

The JSS styleguide is a living example of how to use JSS, hosted right in this app. It demonstrates most of the common patterns that JSS implementations may need to use, as well as useful architectural patterns.

GraphQL

JSS features integration with the Sitecore GraphQL API to enable fetching non-route data from Sitecore - or from other internal backends as an API aggregator or proxy. This route is a living example of how to use an integrate with GraphQL data in a JSS app.

This app is a boilerplate

The JSS samples are a boilerplate, not a library. That means that any code in this app is meant for you to own and customize to your own requirements.

Want to change the lint settings? Do it. Want to read manifest data from a MongoDB database? Go for it. This app is yours.

How to start with an empty app

To start with a fresh app with no boilerplate, run npx create-sitecore-jss and don't select any add-ons. Note, disconnected mode is not supported this way

To remove all of the default sample content (the Styleguide and GraphQL routes) and start out with an empty JSS app:

  1. Delete /data/dictionary/*.yml
  2. Delete /data/routes/styleguide and /data/routes/graphql
  3. Delete /data/content/Styleguide
  4. Delete /data/component-content/Styleguide
  5. Delete /sitecore/definitions/components/Styleguide*, /sitecore/definitions/templates/Styleguide*, and /sitecore/definitions/components/GraphQL*
  6. Delete graphql-let command from bootstrap npm command in package.json until you create .graphql files
  7. Delete /src/components/*