Requirements

Install the VTEX IO CLI on your machine

For more information, please refer to this guide.

Install Headless CMS and its dependencies

Headless CMS is the content management solution for FastStore projects. During the Onboarding, the integration between your project and 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, follow the instructions below:

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 the next requirement. If not, continue following these instructions.
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 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 requirement.

Install Headless CMS plugins

To ensure you won't get errors while running Headless CMS commands in the CLI, install Headless CMS plugins by following these steps:

Open the terminal and log in to your VTEX account using the VTEX IO CLI:

Remember to replace the values between curly brackets according to your account name.

_10vtex login {account}
Install Headless CMS plugins:

_10vtex plugins install cms

Now, check if the installation of Headless CMS plugins was successful by running vtex cms.

${"base64":" ","img":{"width":2142,"height":636,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":123285,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/faststore-vtex-cms___460365970fb39c94e300b9fbd497e17e.png"}}$

Windows user: If you find problems while installing the plugin, please refer to the Troubleshooting article

macOS user: If you find problems, run yarn config set ignore-engines true to ignore the Node.js incompatibility version, then run vtex plugins install cms again.

Remember, we recommend using the latest Node.js version or a version higher than 15.0.0.

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.

Install the FastStore WebOps app

The FastStore WebOps app is the first step for you to create, set up and manage your FastStore project. It also provides deployment and performance insights of your website.

The FastStore WebOps app only works in stores using the Edition Store. If your store is on the Edition Business, also known as using the Legacy CMS Portal technology, make sure to open a support ticket to change it to the Edition Store. Once you have changed the edition, follow the instructions on this requirements guide.

To install the app, follow these steps.

In a terminal, log into your VTEX account by running the following:

_10vtex login {accountName}

Replace {accountName} with your store account name, for example vtex login store.
Install the FastStore WebOps app by running the following command:

_10vtex install vtex.webops
A confirmation message will appear. Type y to proceed.

_10? Are you sure you want to force this operation on the master workspace on the account store? » (y/N)

The FastStore WebOps app is now installed in your account. Refer to the FastStore WebOps app guide to create your first FastStore project.