App Development

App Development
Local development
Creating a Development workspace

Learn how to create and use a Development workspace.

Development workspaces allow you to link, publish, and install apps. These workspaces provide greater freedom in code development without affecting user traffic and the live store.

Since Development workspaces operate in isolation from user traffic, they are ideal for making code changes. Note: Development workspaces cannot be promoted to Master or used for A/B testing; these capabilities are reserved for Production workspaces.

Step by step

  1. Log in to the desired VTEX account.

  2. Create a development workspace by running the following command:

    vtex use {workspaceName}

    Replace {workspaceName} according to your scenario.

Next steps

Embark on your development journey by creating a new app using our template apps or build from scratch. Link your app and initiate the development process. Once satisfied with the changes in your Development workspace, change to the next phase by creating a Production workspace. This step ensures comprehensive testing of your modifications under real user traffic conditions.

Deleting a workspace

You can manually delete workspaces that are no longer in use by running the following command:

vtex workspace delete {workspaceName}

Deleting a workspace is irreversible, and its content cannot be restored.

Development workspace behavior

In Development workspaces, certain actions are permitted while others are restricted to maintain stability and reliability. Here is a summary of allowed and restricted actions:

Install apps.
Run A/B tests.
Handle traffic.
Promote to master.
App development.
Link an app.
Publish an app.

Key considerations

  • Workspace inheritance: Production workspaces are initiated independently and do not inherit code changes from a Development workspace. Therefore, any modifications made in a Development workspace must be manually replicated to the new Production workspace.
  • Data persistency: Workspace settings persist unless conflicts arise with the Master workspace. In such cases, Master settings take precedence over settings in other workspaces, including the Development ones.
  • Expiration: Once created, Production workspaces have no expiration date.
  • Deletion: Unused workspaces are not automatically deleted. Manually deleting unused workspaces is recommended to optimize platform resources and maintain an efficient operational state.
  • Organization: Maintain a concise list of workspaces for organizational and resource efficiency reasons.
Photo of the contributor
+ 1 contributors
Was this helpful?
Suggest edits (Github)
Photo of the contributor
+ 1 contributors
On this page