Getting started
This documentation is currently under development.
In this Getting Started track, you will build and deploy a FastStore storefront at the domain https://{accountName}.vtex.app/
.
By the end of this track, you'll have a fully functional store using FastStore, seamlessly integrated with VTEX native solutions like Headless CMS (opens in a new tab). Here's an example of the final result: Starter Store (opens in a new tab).
Before you start
1. Install the VTEX IO CLI on your machine.
For more information, please refer to this guide (opens in a new tab).
2. Verify the compatibility of your store's Edition App.
To develop a storefront in FastStore, your account Edition (opens in a new tab) must be vtex.edition-store@5.x
. If you are using a different major version, please open a ticket with VTEX Support (opens in a new tab) and request the installation of the Edition app vtex.edition-store@5.x
.
To check which Edition App version is intalled 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.
3. Run the Intelligent Search integration process.
Integrate the VTEX Intelligent Search (opens in a new tab), an advanced VTEX native search solution that provides accurate, personalized search results to enhance the user experience throughout their shopping journey.
Go to the VTEX Admin and access Store Settings > Intelligent Search > Integrations and click onSTART INTEGRATION
. For more information, refer to the VTEX Intelligent Search documentation (opens in a new tab).
4. Request the installation of the FastStore Onboarding app.
Open a ticket with the VTEX support team (opens in a new tab) and request the installation of the FastStore Onboarding app.
Track overview
In this section, you will find a concise summary of the FastStore Getting Started track. It provides an outline of the topics covered in each step, giving you a clear roadmap for your journey.
1. FastStore Onboarding app
Create your project with the FastStore Onboarding app. This app streamlines the creation of a FastStore project by configuring essential store settings, creating a dedicated GitHub repository for your project, and defining a default domain for your store.
2. Setting Up the Project
Discover the core technologies used in this tutorial and set up all the necessary tools to create your very first FastStore storefront.
3. Understanding the Project Structure
Learn how to organize your FastStore project and get to know our recommended naming conventions for files and folders.
4. FastStore CLI
Install the FastStore Command Line Interface (CLI), a development tool for starting, building, and developing FastStore projects.
5. Next Steps
Explore additional resources and recommendations to enhance various aspects of your store, including performance and overall user experience.