Installation
This guide walks you through installing the Alokai Compass module in your Storefront project. The Compass module brings AI-powered features to enhance your eCommerce experience with conversational AI, product comparisons, and intelligent search capabilities.
Bootstrapping Compass with Alokai Storefront
To use the Compass integration in your Storefront, perform the following steps:
1
Install the module
From the root of your Storefront project, run the following command:
npx @vsf-enterprise/storefront-cli add-module compass -e=sapcc
Follow the instructions in the command line to complete the installation. This command will:
- copy Alokai Compass module files to the Middleware and Storefront directories,
- install the
@alokai/compasspackage in your Middleware and Storefront apps, - set up example environment variables,
- configure AI Assistant, Use Cases Manager, and AI-powered Search components.
2
Update environment variables
By default, the module installation will set up example environment variables. To connect to your Alokai Compass instance, update .env files in the Middleware directory.
- ALOKAI_COMPASS_API_KEY=<alokai-compass-api-key>
+ ALOKAI_COMPASS_API_KEY=<your-alokai-compass-api-key>
Alokai Compass is not generally available yet. In order to gain early access to Alokai Compass, please reach out to your Alokai partner manager or the Alokai sales team.
What next?
With the Alokai Compass module installed in your Storefront, you're ready to build your first AI workflow!