Requirements

Install the VTEX IO CLI on your machine

For more information, please refer to this guide.

Install the Headless CMS and dependencies

The Headless CMS is the content management solution for FastStore projects. During the Onboarding, the integration between your project and the Headless CMS is initiated.

To prevent content duplication that could cause build failures during Onboarding, it is important to confirm the installation of the following apps in your account:

vtex.admin-cms@1.x
vtex.admin-cms-graphql
vtex.admin-cms-graphql-rc

To check whether you have them installed, refer to Installing the Headless CMS app.

Checking installed apps in your account

Open the terminal and log in to your account using the following command. Remember to replace {accountName} with your account's name.

_10vtex login {accountName}
Run vtex ls to list all the installed apps in your account.
Check if the vtex.admin-cms@1.x, vtex.admin-cms-graphql, and vtex.admin-cms-graphql-rc are in the list.

If yes, proceed to check other requirements. If not, install them by following the instructions in Installing the Headless CMS app.

Installing the Headless CMS app and its dependencies

After logging into your account, install vtex.admin-cms@1.x by running the following command:

_10vtex install vtex.admin-cms@1.x

A successful message will confirm the installation:

${"base64":" ","img":{"width":2018,"height":486,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":122705,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/cms-install___7144afabf5a895ba92905926808507b2.png"}}$
Install the Headless CMS dependencies by running the following command:

_10vtex install vtex.admin-cms-graphql vtex.admin-cms-graphql-rc

Once the app and its dependencies are installed, proceed to check the next requirements.

Enable the VTEX Intelligent Search app in your account

The VTEX Intelligent Search app enhances the user experience by providing accurate and personalized search results throughout the shopping journey. Before developing a storefront in FastStore, you need to enable the app on your account. For more information on the Intelligent Search and its integration, please refer to the VTEX Intelligent Search and Integration Settings guides.

To enable the app, begin by checking the version of your Edition Store account.

Based on the edition version, follow the instructions below.

To confirm which Edition App version is installed in your account, open the terminal and use the VTEX IO CLI. Log in to your account by running vtex login {accountName} and run vtex edition get to see the Edition App version installed on the current account.

Accounts in the vtex.edition-store@5.x

If your account is using the vtex.edition-store@5.x major, the VTEX Intelligent Search app is already included, and you need to integrate the app via VTEX Admin.

To integrate the VTEX Intelligent Search, go to the VTEX Admin and access Store Settings > Intelligent Search > Integrations and click on START INTEGRATION.

Accounts using an edition version below 5.x

In the VTEX IO CLI, log in to your VTEX account by running vtex login {accountName}. Remember to replace the value between brackets with your account name.
If the VTEX Intelligent Search app is not installed in your account, run the following for Intelligent Search:

_10vtex install vtex.search-resolver@1.x vtex.admin-search@1.x

After successfully installing the app, integrate it by accessing the VTEX Admin, go to Store Settings > Intelligent Search > Integrations, and click on START INTEGRATION.

Accounts that want to migrate to the 5.x

If you are using a different major version and want to migrate, please open a ticket with VTEX Support and request the installation of the Edition app vtex.edition-store@5.x.

Request the installation of the FastStore Onboarding app

Open a ticket with the VTEX support team and request the installation of the FastStore Onboarding app.