[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 vtex io documentation creating an interface for your app settings 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/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/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/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/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/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/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/vtex-io-documentation-creating-an-interface-for-your-app-settings/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-managing-application-logs)

[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)

[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-managing-application-logs)

[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)

[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/app-development)

Development guides

[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)

Creating an interface for your app settings

Learn how to create a user interface for your app and fetch data from it.

When developing a [VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app), you can create an interface for accepting custom user settings. The app settings interface allows you to retrieve data provided by the user and enable or modify an app's behavior based on it. The configuration possibilities depend on the type of data collected by the interface and the intended use.

This guide outlines the process of creating such an interface and using the data input by users within your app.

## Usage example

The app settings interface displays configuration forms for installed apps in the [App Store](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/2LDRvGujYsumxi7IlE7CEJ). This interface is defined via the `settingsSchema` field on [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest), where you declare the schema of your app’s configuration.

Below is an example of the Google Tag Manager app interface and its corresponding `settingsSchema` configuration:

| Interface                                                                                | settingsSchema                                                                                |
| ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![GTM_image](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/assets/112641072/d916b8da-0039-4364-b21e-a8cf8ba629dd) | manifest.json1 "settingsSchema": {2 "title": "Google Tag Manager",3 "type": "object",4 "bindingBounded": true,5 "properties": {6 "gtmId": {7 "title": "Google Tag Manager",8 "description": "Enter the ID (GTM-XXXX) from your Google Tag Manager",9 "type": "string"10 },11 "allowCustomHtmlTags": {12 "title": "Allow Custom HTML tags",13 "description": "Beware that using Custom HTML tags can drastically impact the store's performance",14 "type": "boolean"15 },16 "sendGA4Events": {17 "title": "Send Google Analytics 4 Events",18 "description": "When this setting is active, also send the GA4 version of the events",19 "type": "boolean"20 }21 }22 }, |

After building your app's settings interface, you need to consume the data provided by the app’s user. Consider the Google Tag Manager example above, retrieving the GTM ID.

Based on the given example, below are the instructions for creating an interface for your app and retrieving the data to use within the app.

## Instructions

### Step 1 - Creating the settings interface

To create the app settings interface, define the `settingsSchema` object in its `manifest.json` file.

This object declares a JSON Schema with the fields that meet your business needs. See the [JSON Schema documentation](https://read.calvincode.net/reader?url=http://json-schema.org/understanding-json-schema/) to correctly build the `settingsSchema` field.

> The JSON Schema offers a predefined model that outlines how the settings should be formatted in your app. Note that, depending on the JSON Schema specification, the types accepted within a property include: `string`, `number`, `integer`, `boolean`, `object`, `array`, or `null`. You can also use arrays of types (for example, `[string, number]`) to indicate that the property accepts multiple types.

Considering the example of the Google Tag Manager interface previously presented, the `settingsSchema` object was configured as follows:

`1

 "settingsSchema": {

2

 "title": "Google Tag Manager",

3

 "type": "object",

4

 "bindingBounded": true,

5

 "properties": {

6

 "gtmId": {

7

 "title": "Google Tag Manager",

8

 "description": "Enter the ID (GTM-XXXX) from your Google Tag Manager",

9

 "type": "string"

10

 },

11

 "allowCustomHtmlTags": {

12

 "title": "Allow Custom HTML tags",

13

 "description": "Beware that using Custom HTML tags can drastically impact the store's performance",

14

 "type": "boolean"

15

 },

16

 "sendGA4Events": {

17

 "title": "Send Google Analytics 4 Events",

18

 "description": "When this setting is active, also send the GA4 version of the events",

19

 "type": "boolean"

20

 }

21

 }

22

 },

`

This code defines a schema for the settings UI that interacts with the Google Tag Manager app. The configured fields are described below:

* `title`: App name displayed in the app settings interface. We recommend using the same app name configured in the [title field of the manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest%23title).
* `type`: JSON Schema type (this must always be set as `object`).
* `description` (optional): Description of the `settingsSchema` field.
* `access` (optional): Defines the visibility of the app’s settings. When set to `public`, the settings become accessible through the `publicSettingsForApp` query. If omitted, the query will not return any data.
* `properties`: Key-value pairs that define the fields that will be displayed to the app users, with their own definition within this object. Each defined key accepts the following `properties`: `title`, `description`, and `type`.
* `gtmId`: String-type property that represents the Google Tag Manager ID. In the settings UI, this property is shown as a text box.
* `allowCustomHtmlTags`: Boolean-type property that determines whether custom HTML tags are allowed. In the settings UI, this property is displayed as a checkbox.
* `sendGA4Events`: Boolean-type property that indicates whether to send Google Analytics 4 events. In the settings UI, this property is displayed as a checkbox.

> Setting `access` field to `public` makes **all configuration data publicly accessible**. Use this option only if you are certain that no sensitive information is stored in the app's settings.

### Step 2 - Retrieving and consuming the app settings data

In your app’s code, you can retrieve the app settings in two ways:

* [Frontend apps](#frontend-apps): Use a GraphQL query to fetch app settings.
* [Backend apps](#backend-apps): Use the `getAppSettings` method from the `ctx.clients.apps` client.

Below is an example of each case.

> Make sure your app has the required permissions to communicate with the frontend or backend app. Without proper permissions, your store won’t be able to share data with the solution. Learn more in [Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies).

#### Frontend apps

1. In the `manifest.json` file, add the `vtex.apps-graphql@3.x` within the `dependencies` field.
2. In the `react` directory, create a new folder named `queries`.
3. Create a new `graphql` file (for example, `AppSettings.graphql`) and query the settings options as in the following example.

`1

query getSettings {

2

 publicSettingsForApp(app: "{vendor}.{app.name}", version: "0.x")

3

 @context(provider: "vtex.apps-graphql") {

4

 message

5

 }

6

}

`

> Replace `vendor`, `app.name`, and `0.x` with values based on your scenario. In the case of the Google Tag Manager app, the `app` value is `vtex.google-tag-manager`, and the `version` value is `1.x`.

The example above is a GraphQL query that fetches the data of a specific app declared in the arguments of `publicSettingsForApp` field: the app and its version. The configured fields are described below:

* `@context(provider: "vtex.apps-graphql")`: The context for the query. In this case, it must be configured as "vtex.apps-graphql".
* `message`: The message field to be included in the query result, which is a field within the `publicSettingsForApp` object. The message may vary depending on the app's settingsSchema.

This query will return an object like the one below:

`1

{

2

 "data": {

3

 "publicSettingsForApp": {

4

 "message": "{\"gtmId\": \"GTM-1234\"}"

5

 }

6

 }

7

}

`

1. Open the `tsx` file of the React component that will consume this information and import the GraphQL query:

`1

import AppSettings from './queries/AppSettings.graphql'

`

1. Parse and use the defined query value (for example, `AppSettings`) based on your needs. See the example below:

`` 1

 const { data: appSettingsData } = useQuery(AppSettings, {

2

 variables: { version: process.env.VTEX_APP_VERSION },

3

 ssr: false,

4

 });

5

6

 useEffect(() => {

7

 if (appSettingsData) {

8

 const { gtmId } = JSON.parse(appSettingsData.publicSettingsForApp?.message || '{}');

9

 if (gtmId) {

10

 window.dataLayer = window.dataLayer || [];

11

 window.dataLayer.push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' });

12

 const script = document.createElement('script');

13

 script.src = `https://www.googletagmanager.com/gtm.js?id=$\{gtmId\}`;

14

 document.head.appendChild(script);

15

 }

16

 }

17

 }, [appSettingsData]);

 ``

The code above interacts with an API through a GraphQL query, which is managed by the `useQuery` hook, to fetch the app settings. When the data is retrieved, a `useEffect` hook parses the settings, extracts the `gtmId`, and dynamically initializes GTM by injecting its script into the document if the `gtmId` is available.

#### Backend apps

1. Open your `node` app in any code editor of your choice.
2. Declare a new function (for example, `getConfig`) and use the `getAppSettings` method from the `apps` client to retrieve and return the app settings data. See the example below:

`1

export const getConfig = async (_: any, __: any, ctx: Context) => {

2

 const {

3

 clients: { apps },

4

 vtex: { logger },

5

 } = ctx;

6

7

 const appId = process.env.VTEX_APP_ID;

8

9

 try {

10

 const settings = await apps.getAppSettings(appId);

11

 return settings;

12

 } catch (error) {

13

 logger.error({

14

 message: 'getConfig-getAppSettings-error',

15

 error,

16

 });

17

 }

18

};

`

The `getConfig` function returns a promise as it fetches the app settings and handles errors. It retrieves an app ID from environment variables, uses it to request settings, and logs any errors.

1. Import the defined function and consume it based on your needs. For example, you can use it in a resolver, middleware, or any other part of your backend app.

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F65139761%3Fv%3D4%26w=64%26q=75)](https://github.com/RezenDeveloper)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-creating-an-interface-for-your-app-settings.md)

[Running IO scripts in non-IO VTEX stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings//docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)[Node appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings//docs/guides/app-development-guides)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F65139761%3Fv%3D4%26w=64%26q=75)](https://github.com/RezenDeveloper)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

ON THIS PAGE

[Usage example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23usage-example)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23instructions)

[Step 1 - Creating the settings interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-1-creating-the-settings-interface)[Step 2 - Retrieving and consuming the app settings data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-2-retrieving-and-consuming-the-app-settings-data)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-creating-an-interface-for-your-app-settings.md)

Copy page

On this page

ON THIS PAGE

[Usage example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23usage-example)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23instructions)

[Step 1 - Creating the settings interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-1-creating-the-settings-interface)[Step 2 - Retrieving and consuming the app settings data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-2-retrieving-and-consuming-the-app-settings-data)

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 enabling an access control list acl in b2b suite 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/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/bulk-import-buyer-organizations-spreadsheet)

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/bulk-import-buyer-organizations-spreadsheet)

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides)

B2B Suite

B2B Organizations

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)

Enabling an access control list ACL in B2B Suite

The **Access Control List (ACL)** feature in B2B Suite allows you to restrict access to resources such as **buyer organizations**, **cost centers**, and **members** in the VTEX Admin. You need to set up specific permissions to allow the users to view or manage these resources.

If a user doesn't have the required permissions, they won't be able to access the **Buyer organizations** section in the VTEX Admin.

## Required permissions

To allow access to the apps related to B2B Organizations in the VTEX Admin, you need to add the following roles:

| Permission Name               | Description                                                                    |
| ----------------------------- | ------------------------------------------------------------------------------ |
| **buyer\_organization\_view** | Allows viewing organizations, cost centers, and users.                         |
| **buyer\_organization\_edit** | Allows creating, editing, and deleting organizations, cost centers, and users. |

These permissions are available under the **Buyer organizations/Management** resource. Follow the steps below to access this resource:

1. Access the VTEX Admin.
2. In the upper right corner, click the icon with your initial.
3. Click **Account settings**.
4. Click **User roles**.

## Updating B2B Suite apps

To enable the ACL feature, follow the steps below:

1. Open the terminal [Using VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage).
2. Run the commands below to update the B2B Suite apps.

`1

vtex install vtex.storefront-permissions@3.1.0 --force

2

vtex install vtex.b2b-organizations-graphql@2.0.1 --force

3

vtex install vtex.b2b-quotes-graphql@4.0.1 --force

4

vtex install vtex.b2b-orders-history@2.0.1

5

vtex install vtex.storefront-permissions-ui@3.0.1

6

vtex install vtex.b2b-organizations@3.0.1

7

vtex install vtex.b2b-quotes@3.0.1

8

vtex install vtex.storefront-permissions-components@2.0.1

9

vtex install vtex.b2b-admin-customers@2.0.1

10

vtex install vtex.b2b-my-account@2.0.0

11

vtex install vtex.b2b-checkout-settings@3.0.1 --force

12

vtex install vtex.b2bstore@5.0.0

13

vtex install vtex.b2b-suite@2.0.0

`

> If any of the apps above are not installed in your store, update only the ones you have.

1. Run the command below to check if there are any dependencies on older versions.

`1

vtex deps list | grep <app-name-without-version>

`

1. If there are any apps with an older version, update them as described in step 2.

> To revert to a previous version, reinstall the earlier versions of each app.

## Updating custom apps with ACL support

If your account uses custom apps that depend on the **b2b-organizations-graphql** or **storefront-permissions** apps, you need to update the `manifest.json` file to include the permission policies.

The `manifest.json` file is located at the root of the app repository. Open the file in a code editor and add the following policies in the `policies` section:

`1

"policies": [

2

 {

3

 "name": "buyer_organization_view"

4

 },

5

 {

6

 "name": "buyer_organization_edit"

7

 }

8

]

`

After saving the file, publish the app again to apply the changes.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F136460310%3Fv%3D4%26w=64%26q=75)](https://github.com/geisecosta)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/B2B-Suite/b2b-organizations/enabling-an-access-control-list-acl-in-b2b-suite.md)

[How to configure tradeName to use in the organization search field« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite//docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)[How to customize VTEX Sales AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite//docs/guides/how-to-customize-vtex-sales-app)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F136460310%3Fv%3D4%26w=64%26q=75)](https://github.com/geisecosta)

ON THIS PAGE

[Required permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23required-permissions)

[Updating B2B Suite apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-b2b-suite-apps)

[Updating custom apps with ACL support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-custom-apps-with-acl-support)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/B2B-Suite/b2b-organizations/enabling-an-access-control-list-acl-in-b2b-suite.md)

Copy page

On this page

ON THIS PAGE

[Required permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23required-permissions)

[Updating B2B Suite apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-b2b-suite-apps)

[Updating custom apps with ACL support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-custom-apps-with-acl-support)

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 1 onboarding starting the project 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/1-onboarding-starting-the-project/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/updates/release-notes)

Storefront Development

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

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-overview)

[1\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-6-next-steps)

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

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/headless-cms-overview)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/updates/release-notes)

Storefront Development

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

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-overview)

[1\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-6-next-steps)

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

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/headless-cms-overview)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/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/1-onboarding-starting-the-project/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore)

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

2\. Starting a new FastStore project

Create and set up your FastStore project with WebOps.

In this step, you'll use the [FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) to create your FastStore project, connect it to GitHub, and deploy a live preview.

This establishes your project’s source of truth and CI/CD path — the foundation for all later steps in this track.

## What you'll accomplish

By the end of this step, you will have:

* Created your FastStore project with basic configuration (project name, SEO tags, GTM, catalog)
* Connected your project to a GitHub repository for version control
* Set up the Headless CMS integration for content management
* Deployed your project and generated a live preview of your storefront

Your project will be accessible at `https://{accountName}.vtex.app/` and ready for local development in the next step.

## Getting to know the WebOps app

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) is the **control plane** for FastStore projects. It manages every stage of your storefront’s lifecycle, from creation to deployment, and integrates with your GitHub repository and VTEX account to facilitate collaboration and automation.

![{"base64":"  ","img":{"width":1303,"height":836,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":193459,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/dashboard-overview.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/dashboard-overview.png)

WebOps connects your storefront code (GitHub) with your VTEX infrastructure, enabling a branch-based workflow for development and production. Keep the following in mind:

* **Environment requirement:** WebOps operates exclusively in the production environment. Install it only in your account’s `master` environment.
* **Development workflow:** FastStore uses a [Git branching model](https://read.calvincode.net/reader?url=https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) for development and testing:
   * The app is installed in the `master` environment of your VTEX account.
   * Development and testing occur on Git branches.
   * Approved changes are merged into the repository’s `main` branch and automatically deployed to production.

> Unlike [VTEX IO workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace), FastStore uses a Git-based branching workflow.

## Before you begin

### Check permissions

To start a FastStore project, users must have the **Owner (Admin Super)** [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc%23roles).

### Create your store catalog

Create a catalog to populate and test your store. It should include essential components such as product listing pages, search, product details, and checkout. Developing without a catalog may result in incomplete testing, data integration issues, and rework later.

For more information, refer to the [Catalog documentation](https://read.calvincode.net/reader?url=https://help.vtex.com/docs/tracks/catalog).

### Have a GitHub account

To complete the FastStore WebOps onboarding, you’ll need a GitHub account to host your project. You can use either a [personal account](https://read.calvincode.net/reader?url=https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github) or a [GitHub organization](https://read.calvincode.net/reader?url=https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations).
If you use a GitHub organization, ensure you have **admin access** to it.

## Step 1: Setting up the project

1. Open the VTEX Admin and access **Storefront > FastStore WebOps**.
2. Click `Start Project`.
3. In the **Setup & Create Project** page, configure the following options for your store:

### Project

Choose the option that best fits your project's purpose. This helps us understand what you're trying to achieve with FastStore and improve your experience.

| Field                                                     | Description                                                  |
| --------------------------------------------------------- | ------------------------------------------------------------ |
| **Project name**                                          | Enter your FastStore project's name, e.g., Marcio Car store. |
| **Which option best describes the goal of your project?** | Choose the option that best fits your project’s purpose.     |

### SEO Tags

| Field               | Description                                                                                |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Title Tag**       | Enter a keyword-optimized title for your store. For example: Buy Online with the Best Game Store - GameStore. In this example, we used the length limit of around 50-60 characters to ensure it is fully displayed in search results without being truncated. |
| **Description Tag** | Enter a brief description of your store, for example, Shop online at GameStore, the best game store for PC, Xbox, PS4 and Headphones. Explore our wide selection and buy your favorite games today!                                                           |
| **Title Template**  | Enter a page title that helps search engines and users better understand the content of your store. For example, The best game store - GameStore.                                                                                |
| **Site Author**     | Enter the name of the agency or person responsible for the development of the storefront.                                                                                |

### Google Tag Manager

| Field      | Description                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| **GTM ID** | Enter the Google Tag Manager ID (GTM ID) associated with the GTM container responsible for managing and organizing the tags of your store. |

### Catalog

| Field       | Description                                            |
| ----------- | ------------------------------------------------------ |
| **Catalog** | Choose which catalog your store should be linked with. |

### Terms of use

If you already have content created in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview), be aware that it will be automatically deleted during FastStore WebOps onboarding to avoid content duplication.

To proceed, please confirm that you understand by checking the Terms of use box.

After setting up the basic configuration for your store and reviewing it, click `Continue` to proceed to the next page.

## Step 2: Setting up integrations

On this page, you will set up the native Headless CMS integration and connect to a GitHub organization.

### CMS Integration

Configure the native [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) integration and connect to GitHub.

### Git Provider

Connect with a GitHub personal account or organization of your choice to host the source code of your FastStore project.

> If you choose to install the app in a GitHub organization, make sure you have admin access to an organization.

To connect to the FastStore WebOps app, follow these steps:

1. Click `Connect with GitHub`. A new browser tab will open on the side for you to integrate the app with GitHub.
> If you are not logged in to your GitHub account, in the new tab, you will be asked to log in. Then, you can continue to the next step.
2. Once you are logged in to your GitHub account, choose the organization or your personal account you want to install the app. You will be redirected to the **Settings** page on GitHub.
> Once you define the GitHub organization, you cannot change it later.
3. In **Repository access**, choose one of the following options: **All repositories from the organization** or **Only select repositories**.
4. Click `Install`.

The following successful message will appear on the page:

`1

Success! You can now close this page and proceed with the onboarding process.

`

After seeing the success message, close the browser tab and continue the onboarding process in the VTEX Admin.

1. Now that the app is integrated with GitHub, select which repository you want to start the project:
   * **New repository:** Create a repository from scratch, in this option, you only need to type a name for the repository, and after clicking `Create`, it will create the repository for you.
   * **Existing repository:** Select an existing repository from the organization to start the project.
2. Click `Create`. The deployment process will begin, and once it is complete, you will be redirected to the [Deploy Summary](#step-3--deploying-the-project) page.

## Step 3: Deploying the project

After completing the setup for your store, the deployment process will begin. This process involves creating a GitHub repository and a default domain for your project. Once the deployment process is complete, you should see the following:

![{"base64":"  ","img":{"width":1332,"height":848,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":79888,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/deploy-summary-webops___ff30808c6eef395f89173c38880b683f.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/deploy-summary-webops___ff30808c6eef395f89173c38880b683f.png)

| Option              | Description                                                                                |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Your Repository** | Access the store's GitHub repository and start setting up and customizing your store.                                                                                |
| **Documentation**   | Access the FastStore Portal Documentation.                                                                                |
| **Customization**   | Access the documentation on how to customize your store.                                                                                |
| **View Dashboard**  | Access the Dashboard with the current status of your store, including its domains, deployed versions, store preview, and Lighthouse scores. For more information, please refer to the [Dashboard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) guide. |

> If repository creation fails and no live preview is generated, click **Retry** to redeploy.

## Next step

Now that your store is up and running with a live preview, set up your local development environment: [3\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/_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/1-onboarding-starting-the-project/_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/2-starting-the-project.mdx)

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

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/_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/1-onboarding-starting-the-project/_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/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23what-youll-accomplish)

[Getting to know the WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23getting-to-know-the-webops-app)

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

[Check permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23check-permissions)[Create your store catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23create-your-store-catalog)[Have a GitHub account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23have-a-github-account)

[Step 1: Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-1-setting-up-the-project)

[Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23project)[SEO Tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23seo-tags)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23google-tag-manager)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23catalog)[Terms of use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23terms-of-use)

[Step 2: Setting up integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-2-setting-up-integrations)

[CMS Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23cms-integration)[Git Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23git-provider)

[Step 3: Deploying the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-3-deploying-the-project)

[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%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/2-starting-the-project.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/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23what-youll-accomplish)

[Getting to know the WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23getting-to-know-the-webops-app)

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

[Check permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23check-permissions)[Create your store catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23create-your-store-catalog)[Have a GitHub account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23have-a-github-account)

[Step 1: Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-1-setting-up-the-project)

[Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23project)[SEO Tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23seo-tags)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23google-tag-manager)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23catalog)[Terms of use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23terms-of-use)

[Step 2: Setting up integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-2-setting-up-integrations)

[CMS Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23cms-integration)[Git Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23git-provider)

[Step 3: Deploying the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-3-deploying-the-project)

[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%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=)