Publishing an app on VTEX IO

Publishing an app on VTEX IO

Introduction

After being presented to the concepts regarding the types of workspaces, we're going to teach how to publish an app on VTEX IO. In order to realize operations like these and have access to the platform features, we use VTEX IO's CLI.

Using VTEX IO's CLI to publish an app

To publish an app on VTEX IO, one needs to use the following command on VTEX IO's CLI inside the app's folder:

vtex publish

Which app are we going to publish?

At the end of the Store Framework course, you implemented a functional store and it's that app you are going to publish.

What if I did not take the Store Framework course?

Do not worry, for this step, you can use any theme that you already have and publish it. In case of not having one, you can go back to our courses and create one!

With an application of a theme, go to manifest.json file and change the app name to the following format:

trainingweek-{{devname}}

where devname is a name of your choice, that identifies you. Besides, it's necessary to change the application vendor, which needs to be appliancetheme.

Below you will find a part of a valid manifest.json file with the previous changes already made:

{
    "vendor": "appliancetheme",
    "name": "trainingweek-fabiana",
    ...
}

By the end of this step, we're are going to effectively publish the app. Inside the app's directory, run the command that was mentioned at the beginning of the step. When running the command, you will need to confirm the action, as you can see in the following image:

imageimage

After confirming it, the app's building will start and, after finishing it, you should see a message saying that the publishing process was successful.

imageimage

Well done! You've just published your first app!


Help us make this content better!

VTEX IO courses are open source. If you see something wrong, you can open a pull request!

Make a contribution

or open an issue