Documentation
Feedback
Guides
Storefront Development

Storefront Development
Dashboard
After successfully deploying and creating the repository and live preview of your store, you can access the Dashboard page for detailed information about your store deploys. The Dashboard displays the current status of your store, including its domains, deployed versions, store preview, and commits.
{"base64":"  ","img":{"width":1652,"height":571,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":180046,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/dashboard-overview___56923825cfdcfc7018cbfe3a9aa726ee.gif"}}
On the Dashboard page, you will find two main views: Overview and Deploys. For more information about each view, continue reading the next sections.

Overview

The Overview section provides information about the production deployment of your store.
{"base64":"  ","img":{"width":1500,"height":775,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":39341,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/dashboard-view-overview___7b8f9c67ff14be86263514d62ae471f1.png"}}
Check out the table below for more information:
FieldDescription
Preview FastStoreOpens a preview of your store in a new tab.
DeploymentOpens the deployed version of the store in a new tab.
DomainOpens the URL of your store's domain, which is the same as the preview.
Last commitDisplays the most recent commit to your store's repository, including the date, month, year, and the GitHub user who made the commit.
StatusDisplays the status of the deployment. For more information on the status values, refer to Status available values.

Status available values

The Status field can have one of the following values:
  • Success: The deployment was successful. If you want to check the commit associated with it, go to the Deploys tab.
  • Error: An error in the pipeline caused the deploy to fail. To identify the specific step where the error occurred, access the Deploys tab and check the last commit. Then, access your store repository and verify the pipeline related to that commit.
    Note that a deploy can fail even if the build process is successful. In this case, even though the code compiled correctly, the deploy may have failed in a specific step of the pipeline.

Deploys

The Deploys section provides a summary of each deployment made in your store's repository.
{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAACCAIAAADwyuo0AAAACXBIWXMAABYlAAAWJQFJUiTwAAAAJUlEQVR4nAEaAOX/AK6uru7u7t7e3trb2wAiIiKBgYFjY2KTkpHakA7G26fbvAAAAABJRU5ErkJggg==","img":{"src":"https://vtexhelp.vtexassets.com/assets/docs/src/dashboard-view-deploys___e5f04f3e5613d52e4b2864ef48134608.png","width":1466,"height":774,"type":"png"}}
FieldDescription
Preview URLDisplays the URL to the deploy preview of a specific commit.
CommitDisplays the commit hash associated with a particular commit.
TimestampDisplays the date and time of the commit in the format dd/mm/yyyy.
Elapsed timeDisplays the time it took to complete the commit process.
DeployIndicates the status of the deployment. Possible statuses are Success and Failed. For more information on the Failed status, go to the repository and check what failed in the commit.
Quality checksProvides an overview of the status of quality checks, including Lighthouse audits and Integration Tests. These checks help you identify and prevent regressions in your store. For more information on the Quality checks values, refer to Quality checks available values. Remember: Lighthouse audits are an essential step in the go-live checklist. Ensure you achieve the recommended score for the lighthouse checks to pass.
More actions menu ()Opens a list with the following options after being clicked:
  • Preview: Opens the store preview for the commit in a new tab.
  • Commit: Opens the commit page in GitHub in a new tab.
  • Quality checks available values

    The Quality checks field can have one of the following values:
    • Success: All checks have passed.
    • Skipped: In the CI process, specific checks were not performed for certain commits. This often occurs when the commit being tested was never the HEAD commit of the main branch, saving time and resources without compromising code quality.
    • Failed: For more information on the Failed status, go to the repository and check what failed in the commit.

    Deleting the project

    To delete your FastStore project, click the More actions menu (). Then, click Delete Project.
    A modal to confirm your choice will open.
    Proceed with caution. Deleting the project is irreversible and will permanently remove all deployments and domains associated with it.
    {"base64":"  ","img":{"width":1491,"height":770,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":605440,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/dashboard-delete-project___46d68be9204ce3948c1785235aeae59f.gif"}}
    Contributors
    1
    Photo of the contributor
    + 1 contributors
    Was this helpful?
    Yes
    No
    Suggest edits (Github)
    Contributors
    1
    Photo of the contributor
    + 1 contributors
    On this page