Vue Storefront is now Alokai! Learn More
Installation

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 get access to this module and installation assistance, please contact the Alokai sales team or reach out to your Customer Support Manager.

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.

apps/storefront-middleware/.env
- 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!