Documentation
Feedback
Guides
Storefront Development

Storefront Development
FastStoreGetting Started1. FastStore WebOps
Starting a new FastStore project
Now that you have an overview of the app, it's time to kickstart your project. In this guide, you will:
  • Create your FastStore project with the FastStore Onboarding app.
  • Configure a GitHub repository for your project.
  • Generate a live preview of your store.

Instructions

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.
FieldDescription
Project nameEnter 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

FieldDescription
Title TagEnter 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 TagEnter 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 TemplateEnter a page title that helps search engines and users better understand the content of your store. For example, The best game store - GameStore.
Site AuthorEnter the name of the agency or person responsible for the development of the storefront.

Google Tag Manager

FieldDescription
GTM IDEnter the Google Tag Manager ID (GTM ID) associated with the GTM container responsible for managing and organizing the tags of your store.

Catalog

FieldDescription
CatalogChoose which catalog your store should be linked with.

Terms of use

If you already have content created in the Headless CMS, 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: Integrations

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

CMS Integration

Choose this option to integrate with the Headless CMS, VTEX's Content Management solution.
After setting up the basic configuration for your store and reviewing it, click Create to proceed to the next page, Deploy Summary.

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:

_10
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 one: Select one existing repository from the organization to start the project.
  2. Click Create. The deploy process will begin and, once the deployment process is complete, you will be redirected to the Deploy Summary page.

Step 3: Deploying the project

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

Repository and live Store created

{"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"}}
In this scenario, both the repository and the live preview of the store have been successfully created. You now have the following options:
OptionDescription
Your RepositoryAccess the store's GitHub repository and start setting up and customizing your store.
DocumentationAccess the FastStore Portal Documentation.
CustomizationAccess the documentation on how to customize your store.
View DashboardAccess 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 guide.
Now that your store is up and running, let's set up the development environment by following the step-by-step instructions in Setting up the Project.

Repository creation failed

In this scenario, the repository creation was unsuccessful, resulting in the failure to generate the live store preview. Click Retry to redeploy the process. Once the issue is resolved, you will see the Repository and Live Store created scenario.

Next Step

Now that your store is up and running, let's set up your development environment by following the step-by-step instructions in Setting up the Project.
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page