isabella232 / jss

Official repo of Sitecore JavaScript Services

Sitecore JavaScript Services

This repository contains source code for all Sitecore JSS packages as well as samples to help you get started using Sitecore JSS.

Below is a list of samples included in this repo:

1. React

   Built using create-react-app as a starting point. Supports out-of-the-box Sitecore functionalities (i18n, routing, GraphQL, set <title> tags) and demonstrates how to work with various Sitecore data types, placeholder nesting and wrapping techniques, and other helpful JSS patterns. The application code is heavily commented, but documentation also exists.

2. Vue

   Built using @vue/cli as a starting point. Supports out-of-the-box Sitecore functionalities (i18n, routing, GraphQL, set <title> tags) and demonstrates how to work with various Sitecore data types, placeholder nesting and wrapping techniques, and other helpful JSS patterns. The application code is heavily commented, but documentation also exists.

3. Angular

   Built using angular-cli as a starting point. Supports out-of-the-box Sitecore functionalities (i18n, routing, GraphQL, set <title> tags) and demonstrates how to work with various Sitecore data types, placeholder nesting and wrapping techniques, and other helpful JSS patterns. The application code is heavily commented, but documentation also exists.

4. Embedded JSS App within Sitecore MVC

   This app demonstrates how to embed a client-side JSS application inside an existing Sitecore MVC site as opposed to running a standalone JSS site. This technique essentially embeds the JSS app's markup and app wrapper tag within a Sitecore rendering. Documentation.

5. React Native

   This app demonstrates experimental JSS usage with React Native. Due to the experimental nature of React Native support in JSS, this app does not have feature parity with the other framework samples (e.g. React, Vue). Documentation

6. Sitecore JavaScript rendering [Deprecated]

   This project demonstrates experimental support for creating Sitecore renderings that will server-side render individual JavaScript components or apps. The Sitecore JavaScript renderings can be used alongside traditional MVC-based renderings. Documentation

7. Headless Server-Side Rendering with Node.js

   JSS supports headless server-side rendering using any service that supports hosting Node.js applications. Documentation.

Getting started with JSS

• Official JSS documentation
• StackExchange
• Community Slack
• Sitecore Community Forum

Contributions

We are very grateful to the community for contributing bugfixes and improvements. We welcome any and all efforts to evolve and improve Sitecore JavaScript Services; read below to learn how you can take part in those efforts.

Code of Conduct

Sitecore has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React.

License

Sitecore JavaScript Services is using the Apache 2.0 license.

Support