Storefront Development

Storefront Development
Store FrameworkGetting started
2. Configuring your account

Set up your account Edition to get started with Store Framework.

Now that you have completed the basic setup for VTEX IO, it is time to configure your account to leverage the full power of the VTEX Store Framework. This guide will walk you through two essential prerequisites: Setting your account's Edition app and Implementing the VTEX Intelligent Search.

By fulfilling these prerequisites, you will ensure your store is ready to harness the VTEX Store Framework's capabilities, avoiding potential technical issues during the implementation process.

Step by step

Step 1 - Setting your account's Edition app

The Edition app plays a pivotal role in your VTEX account by installing a bundle of settings and basic configurations. To check which Edition app is currently installed in your account, use the following command:

vtex edition get

If the current edition differs or is older than vtex.edition-store@3.x, open a support ticket and request the installation of the vtex.edition-store@3.x or a newer one in your VTEX account.

ℹ Note that both new VTEX accounts and accounts previously using the Legacy CMS Portal need to formally request the installation of the vtex.edition-store@3.x or a more recent version of this Edition app. This is necessary, as every VTEX account is configured by default with the Legacy CMS Portal Edition app (vtex.edition-business).

Refer to the Edition App article to know more about its different versions and identify the most suitable version for your specific scenario.

Before you can begin building your storefront with Store Framework, you need to configure Intelligent Search.

If you use the vtex.edition-store@3.x version, you must also install the Search apps. If you use the vtex.edition-store@5.x, you must start the Search Integration process directly, as the Intelligent Search is already configured by default in this version.

Intelligent Search is an advanced search engine designed to assist shoppers throughout their entire purchasing journey. It serves as an alternative to the platform's legacy native search engine, but it requires the installation of two apps on your VTEX account:

  • admin-search - Allows stores to configure every functionality made available by the search solution, including initial catalog indexing.
  • search-resolver - Serves as the main backend app for Intelligent Search, handling all search queries.

Installing the Search apps

  1. Open the terminal and log in to your VTEX account:

    vtex login {accountName}

    Replace {accountName} with your account name.

  2. After successfully logging in, run the following command to install the admin-search and search-resolver apps at the master workspace:

    vtex install vtex.admin-search

Starting the Search Integration process

After successfully installing the Intelligent Search apps, follow these steps to index and integrate Intelligent Search with your store's catalog:

  1. Access the Admin.

  2. Go to Store Settings > Intelligent Search > Integrations.

  3. Click the Start integration button to initiate the integration process.

    {"base64":"  ","img":{"width":2096,"height":986,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":102637,"url":""}}

The indexing process will start, and you will receive a link to the Indexing Status screen.

Once the indexing is complete, it will fully equip you to begin using Store Framework successfully.

Photo of the contributor
+ 1 contributors
Was this helpful?
Suggest edits (Github)
See also
3. Creating a Store Theme project
Storefront Development
Photo of the contributor
+ 1 contributors
On this page