[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore developer tools config options in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)

[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options)

[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-custom-cypress)

[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-faststore-cli)

[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-updating-the-cli-package-version)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)

[Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options)

[Custom Cypress integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-custom-cypress)

[FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-faststore-cli)

[Updating the @fastore/cli package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-updating-the-cli-package-version)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)

Configuration options for discovery.config.js

The `discovery.config.js` is a configuration file for managing settings that control store behavior, appearance, and functionality. This file serves as a central hub for configuring key aspects of your FastStore website, including SEO, API connections, session management, analytics, and more.

This guide outlines the configuration options for tailoring your FastStore website using the `discovery.config.js` file.

## Example file

`1

module.exports = {

2

 seo: {

3

 title: "FastStore Starter",

4

 description: "Fast Demo Store",

5

 titleTemplate: "%s | FastStore",

6

 author: "FastStore",

7

 },

8

 theme: "custom-theme",

9

 platform: "vtex",

10

 api: {

11

 storeId: "storeframework",

12

 workspace: "master",

13

 environment: "vtexcommercestable",

14

 hideUnavailableItems: false,

15

 incrementAddress: false,

16

 },

17

};

`

Check the full file example at [discovery.config.js sample code](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/starter.store/blob/main/discovery.config.js).

> As of December 16, 2024, `discovery.config.js` is the new filename for the legacy `faststore.config.js` file. If you're still using the legacy name, see [this release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2024-12-16-discovery-config-file) to update it.

## Configuration options

Below is a description of each setting you can configure in the `discovery.config.js` file:

### `seo`

Sets default metadata related to Search Engine Optimization (SEO), influencing how your store appears in search results. Learn more in [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview).

| Property      | Type   | Description                                                             | Example                |
| ------------- | ------ | ----------------------------------------------------------------------- | ---------------------- |
| title         | string | Store headline displayed in search results (60 characters recommended). | "FastStore Starter"    |
| description   | string | Brief description of the store (150-160 characters optimal).            | "FastStore Demo Store" |
| titleTemplate | string | Dynamic page title pattern. Use %s as a placeholder.                    | "%s \| FastStore"      |
| author        | string | Content author/owner for attribution.                                   | "FastStore"            |

---

### `theme`

Defines the visual identity of your FastStore project, including color schemes, typography, and layout presets. This field is a `string` that specifies the name of the theme being used.

Every FastStore project starts with the [Brandless theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure) by default. However, you can choose from available themes or develop a custom theme. Learn more in [Themes - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview).

---

### `platform`

Defines the ecommerce platform being used. You must set `vtex` as a value to enable VTEX-specific features.

> Only `vtex` is a valid value. Any other value will cause errors.

---

### `api`

Contains settings related to the store's APIs, which link your FastStore storefront to backend services and manage environment-specific behavior.

| Property             | Type    | Description                                                                                | Example              |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| storeId              | string  | VTEX account being used.                                                                                | "mystore"            |
| workspace            | string  | Workspace being used. Use master for the production environment, and other names for staging.                                                                                | "master"             |
| environment          | string  | API environment.                                                                                | "vtexcommercestable" |
| hideUnavailableItems | boolean | Controls product display. When true, hides out-of-stock products. Default value is false.                                                                                | false                |
| incrementAddress     | boolean | Enables automatic completion of address details during checkout using [VTEX’s address API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-address-by-postal-code). When true, missing address fields (such as city, state, street, etc.) are automatically filled based on the provided postal code. Default value is false. | false                |

---

### `session`

Sets up user session defaults, controlling language, currency, location, and shopper attributes.

| Property        | Type      | Description                                                                                | Example               |
| --------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| currency        | object    | Store’s transactional currency for prices, payment, and checkout.                                                                                |                       |
| ├─ code         | string    | ISO currency code                                                                                | "USD"                 |
| └─ symbol       | string    | Currency symbol                                                                                | "$"                   |
| locale          | string    | Language or locale setting for all store text, dates, and numbers. Use standard locale format like en-US for English (US), pt-BR for Brazilian Portuguese, etc.              | "en-US"               |
| channel         | object    | Identifies the commercial and regional context for handling catalog, pricing, and logistics.                                                                                |                       |
| ├─ salesChannel | string    | Trade policy that handles catalog, prices, and fulfillment options (example: different regions or seller-specific rules).                                                    | "1"                   |
| └─ regionId     | string    | Internal identifier used to define regional segmentation based on the user’s location for services such as catalog, shipping, pickup, and other logistics-related processes. |                       |
| country         | string    | ISO country code for the current shopper’s session. This field informs VTEX services which country’s regulations, delivery logistics, and tax rules must be applied.         | "US"                  |
| deliveryMode    | string    | Order fulfillment method, including delivery channel, selected courier or method, delivery window (start and end times), or pickup point.                                    | "delivery"            |
| addressType     | string    | Address format for fulfillment                                                                                | "residential"         |
| postalCode      | string    | User’s postal code                                                                                | "10001"               |
| geoCoordinates  | float\[\] | User’s location as \[latitude, longitude\]                                                                                | \[40.7128, -74.0060\] |
| person          | object    | Shopper identity attributes.                                                                                |                       |
| ├─ id           | string    | Unique VTEX customer ID. VTEX Identity service may auto-populate these fields after sign-in.                                                                                | "12345"               |
| ├─ email        | string    | Customer’s email address                                                                                | "user@email.com"      |
| ├─ firstName    | string    | Customer’s first name.                                                                                | "Alex"                |
| └─ lastName     | string    | Customer’s last name.                                                                                | "Smith"               |

---

### `cart`

Contains the settings to manage the shopping cart’s contents and behavior.

| Property        | Type       | Description                                                                                | Example                            |
| --------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| id              | string     | Unique identifier of the cart.                                                                          | "cart-abc-123"                     |
| items           | array      | Products added to the cart.                                                                             | \[{"sku": "5678", "quantity": 2}\] |
| messages        | string\[\] | System messages associated with the cart, such as shipping changes or other relevant information.       | \["Shipping updated"\]             |
| shouldSplitItem | boolean    | If true, allows cart items from multiple sellers or differing stock locations to be shipped separately. | true                               |

---

### `storeUrl`

Defines the primary store domain as a string. Example: `https://www.mystore.com`.

### `secureSubdomain`

Defines the HTTPS-enabled subdomain, if used, as a string. Example: `https://secure.mystore.com`.

### `checkoutUrl`

Defines the URL for the checkout process as a string. Example: `https://www.mystore.com/checkout`.

### `loginUrl`

Defines the URL for the login process as a string. Example: `https://www.mystore.com/login`.

### `accountUrl`

Defines the URL for the customer's account management page as a string. Example: `https://www.mystore.com/account`.

Learn more about store domains in [Associating your custom domain with your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns%23step-4-associating-your-custom-domain-with-your-faststore-project).

---

### `previewRedirects`

Maps redirect URLs for the following page types in preview mode.

| Property | Type   | Description                                   | Example                                |
| -------- | ------ | --------------------------------------------- | -------------------------------------- |
| home     | string | Redirect URL for the homepage.                | "https://preview.mystore.com"          |
| plp      | string | Redirect URL for product listing pages (PLP). | "https://preview.mystore.com/category" |
| search   | string | Redirect URL for search results pages.        | "https://preview.mystore.com/search"   |
| pdp      | string | Redirect URL for product detail pages (PDP).  | "https://preview.mystore.com/product"  |

Learn more in [Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths).

---

### `lighthouse`

Includes settings for [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview), a tool for auditing and improving the quality of web pages.

| Property      | Type   | Description                                        | Example                                                |
| ------------- | ------ | -------------------------------------------------- | ------------------------------------------------------ |
| server        | string | The server URL for running Lighthouse audits.      | process.env.BASE\_SITE\_URL \| 'http://localhost:3000' |
| pages         | object | Maps the URL of pages to be audited by Lighthouse. |                                                        |
| ├─ home       | string | URL of the homepage.                               | '/'                                                    |
| ├─ pdp        | string | URL of a product detail page.                      | "/headphone-white-10000006/p"                          |
| └─ collection | string | URL of a collection page.                          | "/headphones"                                          |

Learn more in [Lighthouse Scores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard%23lighthouse-scores).

---

### `cypress`

Defines which pages [Cypress](https://read.calvincode.net/reader?url=https://docs.cypress.io/app/get-started/why-cypress) should visit in end-to-end tests, ensuring predictable routes for the CI pipeline. Prefer relative URLs (for example, `"/"`, `/headphones`) and deterministic scenarios with consistent data across runs.

| Property                | Type   | Description                                                                                | Example                          |
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------ | -------------------------------- |
| pages                   | object | Maps the URLs of pages for end-to-end testing with Cypress, with each field defined as a string. |                                  |
| ├─ home                 | string | URL of the homepage.                                                                             | "/"                              |
| ├─ pdp                  | string | URL of the product detail page.                                                                  | "/headphone-white-10000006/p"    |
| ├─ collection           | string | URL of a collection page.                                                                        | "/headphones"                    |
| ├─ collection\_2        | string | URL of a secondary collection page.                                                              | "/audio"                         |
| ├─ collection\_filtered | string | URL of a filtered collection page.                                                               | "/headphones?priceRange=100-200" |
| └─ search               | string | URL of a search results page.                                                                    | "/s?q=headphone"                 |

Learn more in [enableCypressExtension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-custom-cypress).

---

### `analytics`

Defines the [Google Tag Manager ID](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/12326985?hl=en%26ref%5Ftopic=14595647%26sjid=12859079805529639111-SA) used by the site to collect events and trigger tags, allowing you to measure interactions, funnels, and conversions.

| Property       | Type   | Description                          | Example       |
| -------------- | ------ | ------------------------------------ | ------------- |
| gtmContainerId | string | The Google Tag Manager container ID. | "GTM-1234567" |

Learn more in [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview).

---

### `experimental`

Contains settings for experimental features.

| Property                | Type   | Description                                                                      | Example |
| ----------------------- | ------ | -------------------------------------------------------------------------------- | ------- |
| nodeVersion             | string | The Node.js version.                                                             | "20"    |
| cypressVersion          | string | The Cypress version.                                                             | "13"    |
| graphqlCacheControl     | object | Settings for GraphQL responses.                                                  |         |
| ├─ maxAge               | number | Maximum time (in seconds) that the response can be cached.                       | 300     |
| └─ staleWhileRevalidate | number | Time (in seconds) during which stale responses can be served while revalidating. | 60      |

---

### `account`

Specifies the VTEX account name used by the project as a string. Example: `mystore`.

---

### `vtexHeadlessCms`

Configures webhook endpoints for [VTEX Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) to trigger publishing, cache invalidation, or content preview whenever changes occur in the CMS.

| Property    | Type             | Description                                                                               | Example                                                        |
| ----------- | ---------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| webhookUrls | array of strings | An array of strings that defines the webhook URLs used to interact with the Headless CMS. | \["https://mystore.myvtex.com/cms-releases/webhook-releases"\] |

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/config-options.mdx)

[Developer tools and references« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-overview)[Custom Cypress integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-custom-cypress)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

ON THIS PAGE

[Example file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23example-file)

[Configuration options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23configuration-options)

[seo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23seo)[theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23theme)[platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23platform)[api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23api)[session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23session)[cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cart)[storeUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23storeurl)[secureSubdomain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23securesubdomain)[checkoutUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23checkouturl)[loginUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23loginurl)[accountUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23accounturl)[previewRedirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23previewredirects)[lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23lighthouse)[cypress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cypress)[analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23analytics)[experimental](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23experimental)[account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23account)[vtexHeadlessCms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23vtexheadlesscms)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developer-tools/config-options.mdx)

Copy page

On this page

ON THIS PAGE

[Example file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23example-file)

[Configuration options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23configuration-options)

[seo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23seo)[theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23theme)[platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23platform)[api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23api)[session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23session)[cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cart)[storeUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23storeurl)[secureSubdomain](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23securesubdomain)[checkoutUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23checkouturl)[loginUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23loginurl)[accountUrl](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23accounturl)[previewRedirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23previewredirects)[lighthouse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23lighthouse)[cypress](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23cypress)[analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23analytics)[experimental](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23experimental)[account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23account)[vtexHeadlessCms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options/docs/guides/faststore/developer-tools-config-options%23vtexheadlesscms)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore getting started 3 running the project locally in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-overview)

[1\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-1-setting-up-your-environment)

[2\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-2-starting-the-project)

[3\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally)

[4\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-4-understanding-the-project-structure)

[5\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)

[6\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-6-next-steps)

[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-glossary)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-overview)

[1\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-1-setting-up-your-environment)

[2\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-2-starting-the-project)

[3\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally)

[4\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-4-understanding-the-project-structure)

[5\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)

[6\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-6-next-steps)

[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-glossary)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-overview)

3\. Running the project locally

Run your FastStore project in a local development environment to preview changes in real time.

In this step, you'll set up your local development environment, allowing you to iterate quickly and safely before shipping changes. Running the project locally gives you hot reload, faster feedback, and a stable foundation for customization.

## What you'll accomplish

By the end of this step, you will have:

* Run your project locally (<http://localhost:3000/>)
* Made your first customization by applying a new theme to your storefront

## Before you begin

### Required tooling

Before cloning your store’s repository, make sure the following tools are installed on your machine:

Node.js

To run your FastStore project, install the latest Node.js or a version higher than `15.0.0`.

* [Install Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en/download)
Yarn

Use the [Yarn](https://read.calvincode.net/reader?url=https://yarnpkg.com/) CLI to manage dependencies and run tasks, such as starting the development server.

Install Yarn on macOS by running the following:

`1

brew install yarn

`

Install Yarn on Windows by running the following:

`1

npm install -g yarn

`

Git

When developing your store's website, you will use [Git](https://read.calvincode.net/reader?url=https://git-scm.com/) to push your code to the cloud. You will also use Git to download and install the required files for your project.

* [Install Git on macOS using Homebrew](https://read.calvincode.net/reader?url=https://git-scm.com/download/mac)
* [Install Git on Windows](https://read.calvincode.net/reader?url=https://git-scm.com/download/win)
* [Install Git on Linux](https://read.calvincode.net/reader?url=https://git-scm.com/download/linux)
Visual Studio Code - Code Editor

When developing your store's website, you will need a code editor to write the code for your project, such as [Visual Studio Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) (also known as VS Code). Visit the [VS Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) website, download, and install the version compatible with your operating system.

> Although you might opt to use an alternative code editor, note that [Visual Studio Code](https://read.calvincode.net/reader?url=https://code.visualstudio.com/) might help you follow along with the FastStore documentation since our documentation may include screenshots from VS Code.

### Enabling Developer Mode (Windows users)

We strongly recommend enabling Developer Mode when using the terminal for FastStore projects. Since FastStore projects rely on creating symlinks, this mode grants the necessary permissions and privileges, reducing the chance of errors during development. To activate Developer Mode, refer to Microsoft's official guide on [Enabling your device for development](https://read.calvincode.net/reader?url=https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development%23accessing-settings-for-developers).

> Running the FastStore project as an Administrator is not recommended.

## Step 1: Cloning the store's repository

1. Open the terminal and navigate to the directory where you want to store your project.
> For Windows users, we highly recommend enabling the [Developer Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project%23enabling-developer-mode-windows-users) to run the terminal.
2. Clone the repository created during the [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project%23step-2-deploying-the-project) by running the following command in the terminal:
`1
git clone https://github.com/{orgName}/{storeName}
`
> Replace `{orgName}` with the GitHub organization where your store's repository is located, and `{storeName}` with the name of your store's repository.
3. Change into the working directory by running the following command:
`1
cd {storeName}
`
4. Install all the dependencies listed in the `package.json` file by running the following command:
`1
yarn install
`
5. Open your FastStore project in any code editor of your choice.

> Note that your store configuration was already set during the [FastStore Onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project). Therefore, there is no need to connect your project to your VTEX account.

If you want to review these configurations, you can access the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/developer-tools-config-options) file in the root directory of your project's repository.

## Step 2: Running a local server

Let's check what the project looks like in a web browser so far.

1. Start a local development server to serve your website:
`1
 yarn dev
`
This may take a few minutes. Once your development server is ready, the command line will output a similar message as the following:
`1
 ready - started server on 0.0.0.0:3000, url: http://localhost:3000
2
 event - compiled client and server successfully in 333 ms (951 modules)
`
> The `dev` command is part of the [FastStore CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli), a pre-configured command line interface in your starter project. Using the CLI, this command enables you to execute code to keep your store's project up-to-date with the [@faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson).
2. Now, open your browser and go to <http://localhost:3000>.
![{"base64":"  ","img":{"width":1887,"height":851,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":18865483,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/starter-gif___42003e72ece61064991a34c3f14e398f.gif"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/starter-gif___42003e72ece61064991a34c3f14e398f.gif)

While the development server is running, changes you save are hot-reloaded in the browser. To stop the server, press `Ctrl + C` in the terminal. To restart it, run `yarn dev` again.

## Step 3: Making the first change in your store frontend

Now that your store is up and running locally, let's make a simple change in the storefront.

We will start updating the store's [theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23available-themes). For this customization, we will use the [Soft Blue theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-soft-blue).

1. Create a new file named `soft-blue.scss` in `src/themes`. This will be the new theme of your store.
2. Add the following styles to `src/themes/soft-blue.scss`:
src/themes/soft-blue.scss
`1
// ----------------------------------------------------------
2
// GLOBAL TOKENS
3
// Theme Soft Blue
4
// ----------------------------------------------------------
5

6
@layer theme {
7
 .theme {
8
 // --------------------------------------------------------
9
 // Colors (Branding Core)
10
 // --------------------------------------------------------
11

12
 // PALETTE
13
 --fs-color-main-0: #ecf0ff;
14
 --fs-color-main-1: #d8e2ff;
15
 --fs-color-main-2: #00419e;
16
 --fs-color-main-3: #002c71;
17
 --fs-color-main-4: #001947;
18

19
 --fs-color-accent-0: #ebdcff;
20
 --fs-color-accent-1: #8d50fd;
21
 --fs-color-accent-2: #732fe2;
22
 --fs-color-accent-3: #5900c8;
23
 --fs-color-accent-4: #4700a0;
24

25
 // HIERARCHY
26
 --fs-color-primary-bkg: var(--fs-color-main-4);
27
 --fs-color-primary-bkg-active: var(--fs-color-main-2);
28
 --fs-color-primary-bkg-light: var(--fs-color-main-0);
29
 --fs-color-primary-bkg-light-active: var(--fs-color-main-1);
30

31
 // SITUATIONS
32
 --fs-color-success-bkg: #cee8de;
33
 --fs-color-warning-bkg: #f6e0ba;
34

35
 // COMPONENTS & STATES
36
 --fs-color-text-display: var(--fs-color-main-4);
37

38
 --fs-color-action-bkg: var(--fs-color-accent-3);
39
 --fs-color-action-bkg-hover: var(--fs-color-accent-2);
40
 --fs-color-action-bkg-active: var(--fs-color-accent-1);
41

42
 // --------------------------------------------------------
43
 // Typography (Branding Core)
44
 // --------------------------------------------------------
45

46
 // FACE
47
 --fs-text-face-body: 'Lato', -apple-system, system-ui, BlinkMacSystemFont, sans-serif;
48

49
 // --------------------------------------------------------
50
 // Refinements
51
 // --------------------------------------------------------
52

53
 // BORDERS
54
 --fs-border-radius: 0.25rem;
55

56
 // SHADOW
57
 --fs-shadow: none;
58
 --fs-shadow-darker: 0 0 10px rgb(0 0 0 / 20%);
59
 --fs-shadow-hover: 0 1px 4px rgb(0 0 0 / 10%), 0 6px 8px rgb(0 0 0 / 10%);
60

61
 // --------------------------------------------------------
62
 // FS UI Components
63
 // --------------------------------------------------------
64
 // Add here the customizations for FastStore UI components.
65

66
 --fs-logo-width: 8rem;
67

68
 [data-fs-product-card] {
69
 --fs-product-card-border-color: transparent;
70
 --fs-product-card-border-color-hover: var(--fs-border-color-light);
71

72
 &[data-fs-product-card-bordered='true'] {
73
 --fs-product-card-border-color: var(--fs-border-color-light);
74
 }
75
 }
76
 }
77
}
`
3. Open the `discovery.config.js` file and change the `theme` from `custom-theme` to `soft-blue`.
discovery.config.js
`1
 theme: 'soft-blue',
`
4. Restart the server and check in the browser the new theme applied to your store. You may need to refresh the page.
![{"base64":"  ","img":{"width":1900,"height":708,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":857356,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/soft-blue___9eb9e3e506de6396df954598739be8f8.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/soft-blue___9eb9e3e506de6396df954598739be8f8.png)
> It is important to highlight that the store's logo is set through the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview).

## Next step

Now that your local environment is running, learn about your project's structure to understand where to make customizations: [4\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-project-structure)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx)

[2\. Starting a new FastStore project« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-2-starting-the-project)[4\. Understanding the project structureNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-4-understanding-the-project-structure)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23what-youll-accomplish)

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23before-you-begin)

[Required tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23required-tooling)[Enabling Developer Mode (Windows users)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23enabling-developer-mode-windows-users)

[Step 1: Cloning the store's repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-1-cloning-the-stores-repository)

[Step 2: Running a local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-2-running-a-local-server)

[Step 3: Making the first change in your store frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-3-making-the-first-change-in-your-store-frontend)

[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23next-step)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/3-running-the-project-locally.mdx)

Copy page

On this page

ON THIS PAGE

[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23what-youll-accomplish)

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23before-you-begin)

[Required tooling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23required-tooling)[Enabling Developer Mode (Windows users)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23enabling-developer-mode-windows-users)

[Step 1: Cloning the store's repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-1-cloning-the-stores-repository)

[Step 2: Running a local server](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-2-running-a-local-server)

[Step 3: Making the first change in your store frontend](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23step-3-making-the-first-change-in-your-store-frontend)

[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-running-the-project-locally/docs/guides/faststore/getting-started-3-running-the-project-locally%23next-step)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore go live before you begin in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin)

[1\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-1-configuring-external-dns)

[2\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-2-integrating-the-vtex-login)

[3\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)

[4\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin)

[1\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-1-configuring-external-dns)

[2\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-2-integrating-the-vtex-login)

[3\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)

[4\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)

Before you begin

Before each production goes live, contact the FastStore team at least four weeks before the date and make sure that the following is complete:

### Configured the account edition

Your account edition is set to `vtex.edition-store@5.x` Edition app in your master workspace.

> If you do not have the appropriate Edition app installed, [open a support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support) requesting the installation of the `vtex.edition-store@5.x Edition` app in your master workspace.

### Deployed the project with FastStore WebOps

The project was deployed with [FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project) app.

### Developed the storefront

The storefront was developed during the [Setting Up the Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project).

## Next

Now, start integrating your FastStore project with VTEX by [Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns).

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/before-you-begin.mdx)

[Going live« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-overview)[1\. Configuring external DNSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-1-configuring-external-dns)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin%23next)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/before-you-begin.mdx)

Copy page

On this page

ON THIS PAGE

[Next](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-before-you-begin/docs/guides/faststore/go-live-before-you-begin%23next)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)