algolia / algolia-pwa-demo

3 stars 1 forks source link

Algolia for Salesforce B2C Commerce - PWA Kit Starter Reference Code

This repository provides a starter code for integrating Algolia into your Salesforce Commerce Cloud PWA Kit project. It demonstrates how to incorporate advanced capabilities such as Autocomplete, InstantSearch, and Recommend into your PWA storefronts.

Overview

The Algolia PWA starter code is based on the Salesforce Commerce Cloud PWA Kit and leverages Algolia's powerful search and discovery features. It serves as a reference implementation and can be used as a starting point for your own PWA Kit projects.

Prerequisites

Before getting started, ensure you have the following:

Please note that this starter code is created based on the retail-react-app version 2.3.1. If you are using a different version, some configurations may vary.

Setup and Installation

  1. Clone this repository:

    git clone https://github.com/algolia/algolia-pwa-demo
  2. Follow the setup and installation steps provided in the documentation.

Integration with Salesforce Commerce Cloud PWA Kit

This starter code uses the template extensibility feature of the official Salesforce PWA Kit. It utilizes the @salesforce/retail-react-app repository as a base template and includes only the overridden or customized files necessary for Algolia integration.

For more information about template extensibility in the Salesforce PWA Kit, refer to the official documentation.

Documentation

For detailed information on how to use and customize this starter code, please refer to our public documentation.

Algolia SFCC Cartridge

In addition to this PWA Kit starter code, we also provide an Algolia SFCC cartridge that enables integration with Salesforce Commerce Cloud. You can find the cartridge repository here.

Live Demo

You can explore a live demo showcasing the capabilities of Algolia integration with PWA Kit at here.

Troubleshooting

If you encounter any issues or have questions, please refer to the Troubleshoot and common issues section in the documentation.

Contributions

We welcome contributions to enhance this starter code. Please refer to the contribution guidelines for more information.

Resources