This guide will teach you how to prepare your app for distribution in the VTEX App Store and enable merchants to benefit from your solution.

Note that every app goes through a homologation process before being available in the VTEX App Store. During this process, our team can reject apps that do not follow the quality, viability, and usability standards presented in the App Store Guidelines. Therefore, be sure to review these guidelines as you develop and prepare your app for distribution.

Before proceeding, ensure you have:

1. Developed your app. Refer to the Developing an app guide for more information.

2. Registered as a VTEX App Store developer.

After developing your app, you must establish whether it will be charged and if it will be public or private on the VTEX IO platform. To set up these options, refer to the Setting your app's billing model guide. Also, check the App Monetization guidelines for more information on this topic.

After establishing your app's billing model, you must set up the marketing assets (e.g., icons, images, and descriptions) that will compose your app's page on the VTEX App Store. During this step, refer to our Marketing guidelines.

1. Create a new folder named public in the root directory of your project.

2. Inside the public folder, create the metadata folder. Also, create the images, licenses, and messages folders within metadata.

3. Create the following folders and files as shown:

   
   

   _15

   ┗ 📂 public

   _15

   ┣ 📂 metadata

   _15

   ┣ 📂 images

   _15

   ┣ 📄 icon.png

   _15

   ┗ 📂 screenshots

   _15

   ┣ 📂 desktop

   _15

   ┗ 📂 mobile

   _15

   ┣ 📂 licenses

   _15

   ┣ 📄 en-US.md

   _15

   ┣ 📄 es-AR.md

   _15

   ┗ 📄 pt-BR.md

   _15

   ┗ 📂 messages

   _15

   ┣ 📄 en-US.json

   _15

   ┣ 📄 es-AR.json

   _15

   ┗ 📄 pt-BR.json

   
   

4. Create the files and folders needed to compose your App Page as follows:

images folder

The images folder stores the images for your app's page. They may include the app's icon and screenshots showing how the application behaves in the Admin or the storefront. This folder must contain:

• icon.png - The app icon file.
• screenshots - A folder containing the images that will be presented in the App Page's carousel.

Note that you can use the desktop and mobile subfolders to store device-specific images. For example: public/metadata/images/screenshots/mobile and public/metadata/images/screenshots/desktop.

licenses folder

The licenses folder contains the terms and conditions of your app. Licenses establish the direct business relationship between the vendor and the retailer that installs the app.

Inside the licenses folder, create the files named using locale codes to provide your app's terms and conditions in different languages (e.g., public/metadata/licenses/en-US.md, public/metadata/licenses/es-AR.md, public/metadata/licenses/pt-BR.md).

messages folder

The messages folder contains textual information regarding your app, such as its name and list of features, in different languages. See the base template for structuring this file below:

• name: App name, limited to 26 characters.
• headline: Short description of the main functionality of your application. The field has a 120-character limit.
• overview: Detailed description of your app’s main purposes and benefits. There is no character limit.
• features: List of your app’s main features and highlights.
• websiteURL: Link to the app's landing page or your corporate website.
• support: Link to the support channel. This can be an email address, a ticket portal, or a phone number.
• additionalinformation: Additional details and disclaimers related to your app.
• video: URL of a video featuring the app's behavior.
• metricDescription: Billing options' metrics (declared in the app's manifest.json file). This field is required only for apps whose pricing is based on one or more metrics. Do not fill in this field if this is not applicable.

The files in this folder must be available in English, Spanish, and Portuguese, in the following paths: public/metadata/messages/en-US.json, public/metadata/messages/es-AR.json and public/metadata/messages/pt-BR.json, respectively.

If you are satisfied with your new app and marketing content, follow the Deploying a new app version guide to deploy your changes.

After deploying your app's latest version, follow the Submitting your app to the VTEX App Store guide.