⚠️ After March 18, 2024, the FastStore documentation will be migrated to the Developer Portal. For more information, access the official release note.

FastStore

The ultimate toolkit for building blazing-fast storefronts.

What is FastStore?

FastStore (opens in a new tab) is a powerful yet lightweight set of libraries made for developers who want to explore their knowledge and creativity by building comprehensive and unique ecommerce solutions. It supports integration with Headless CMS, allows meaningful analytics capabilities, and gives developers back the freedom of customization.

Our philosophy

Instead of focussing on the next big thing in ecommerce, we tend to focus on what will never change, and try to nail it really well. Our pillars are:

Performance

Amazing UX with great points on Lighthouse and Web Vitals

Stability

Your ecommerce should never lose a sale due to provider issues

Analytics/SEO

Understand who's visiting your store and reach a higher organic traffic


What is included?

FastStore consists of three packages that enable the store to work: FastStore Core, FastStore UI, and FastStore CLI.

FastStore Core (@faststore/core)

Provides the starter source code to get your store up and running. It contains three sub-packages: Components, SDK, and API packages.

The Components package is a library that crafts the behavior of React components into data attributes. The SDK is an extensible state management library that handles all meaningful states an ecommerce store might have, such as:

SDK statesDescription
SessionHandles auth, region, locale, and currency data.
CartHandles a store cart's addition, remotion, update, and current state.
ComponentHandles the state of the components of a store (e.g., display/hide mini cart).
SearchHandles the state of the faceted search (e.g., apply filters and sort).

Our SDKs also provide GA4 compatible analytics functions to help you create powerful analytics capabilities in your ecommerce. Finally, the API package lets you connect to your favorite ecommerce provider by creating interfaces for querying products, collections and manipulating carts.

FastStore UI (@faststore/ui)

Gathers the design system based on FastStore components, using Sass (opens in a new tab) for styling. For more information, refer to the FastStore UI guide.

ℹ️

Although the components use Sass (opens in a new tab), you can work with the desired tool for styling.

FastStore CLI (@faststore/cli)

This package is responsible for unifying the VTEX source code, in @faststore/core, with the customizations and extensions the store will create in the /src folder. It makes debugging easier since we have this division between the VTEX source code and the customizations and extensions.

FastStore never constrains developers to any proprietary framework. It is opinionated by default but flexible under the hood.


What prior knowledge is required?

To follow along with this documentation, you should be familiar with web development fundamentals, including HTML (opens in a new tab), CSS (opens in a new tab) and JavaScript (opens in a new tab), and a basic understanding of the following technologies


What can you learn here?

  • Getting Started

    New to FastStore? Start by creating your first FastStore storefront.

  • Theming

    Explore the look-and-feel of your store by using Themes, FastStore CSS stylesheets.

  • UI components

    Enhance your store's features with these components designed to help you quickly implement and customize features in your store.

  • Headless CMS

    Empower editors to manage web content with the autonomy to create, edit, and publish web content via the VTEX Admin.

  • Building and Customizing sections

    Explore new ways to customize your store components with overriding.

  • Go-live

    Integrate FastStore with VTEX for a seamless customer experience. Connect to VTEX's infrastructure, set up payment gateways, configure shipping options, and launch your store.