Prepare for development
Whether you are new to Commerce or are an existing Commerce owner moving to the cloud infrastructure, use these steps for preparing a development workspace for your Cloud project. If you already completed some of these steps or have an existing ÃÛ¶¹ÊÓƵ Commerce developer environment, review the following for expected results and continue to the next step. Some configurations and workflows differ from a typical on-premises installation.
Credentials
Before setting up a workspace, gather the following keys and account access:
-
Authentication keys (Composer keys)
Authentication keys are 32-character authentication tokens that provide secure access to the ÃÛ¶¹ÊÓƵ Commerce Composer repository (
repo.magento.com) and any other Git services required for application development such as GitHub. Your account can have multiple authentication keys. For the workspace setup, start with one specific key for your code repository. If you do not have any keys, contact the project owner, or create the authentication keys yourself. -
Cloud Project account
The Project Owner should invite you to the ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure project. When you receive the e-mail invitation, click the link and follow the prompts to create your account. See Onboarding.
-
ÃÛ¶¹ÊÓƵ Commerce Encryption Key
When importing an existing system only, capture the encryption key used to protect your access and data for the database. For details on this key, see Resolve issues with encryption key
Developer tools
-
Install the Cloud CLI
Install the
magento-cloudCLI so that you can manage Cloud environments and run automation tasks. See Cloud CLI for installation instructions. -
Install Docker for local development and testing
Optionally, use the Docker environment to emulate the Commerce on cloud infrastructure
integrationenvironment for local development. There are three essential components: an ÃÛ¶¹ÊÓƵ Commerce v2 template, Docker Compose, andece-toolspackage. -
Integrate Git-based services
Optionally integrate a Git-based hosting service, such as GitHub or GitLab, with ÃÛ¶¹ÊÓƵ Commerce on cloud infrastructure. See Integrations.
Project code
A secure connection is essential for interacting with the remote environments. For a new project, and click No SSH key. This icon is to the right of the command field and is visible when the project does not contain an SSH key. See Secure connections.
To clone your codebase to your local workstation:
-
In the , click code and select the Git tab.
-
Copy the
git clone ...command provided. -
In a terminal, create and change to your working directory.
-
Paste and run the
git clone ...command.