Elastic Path Commerce Development

Preparing Elastic Path Source Code

Preparing Elastic Path Source Code

Note: Role: Tech Lead
Dependent on By Documentation
Source control provisioning IT Operations Prepare Infrastructure
Maven repository setup Dev Ops Setup Maven Repository
This page describes how to prepare Elastic Path source code for your project.
  1. Prepare the source code.
    1. Navigate to https://code.elasticpath.com/ep-commerce/ep-commerce.
    2. Clone the repository.
      Note: When you clone an Elastic Path Commerce repository for the first time, follow the instructions in the Cloning via HTTPS guide.
      Warning: Windows File Path Limitation - Do not clone to a directory with a file path greater than 20 characters. Windows file paths are limited to 260 characters. The longest file path in the source code is greater than 230 characters.
      Tip:

      Configure Git to convert line ending to LF on input.

      The command to configure this is:
      git config --global core.autocrlf input
    3. Check out the correct branch and release version of Elastic Path Commerce.
      Tip: Each version branch contains the source code for the release and the subsequent patches. Enable Watch for the repository to get notification of any updates.
    4. Create a development branch in your local repository. The branch name depends on the SCM and branch naming conventions.
    5. Add the Elastic Path Commerce repository to your Git hosting service.
    6. Push the development branch to the Git hosting service.
  2. Configure the Maven extensions/maven/settings.xml file.
    Note: The extensions module contains a maven/settings.xml that you will use.
    1. Replace the PROJECT_REPOSITORY_GROUP_URL placeholder at the top of the file with the <Project EP Repository Group URL> documented during Setup Maven Repository.
    2. Make any other changes required for your project environment.
    3. Commit the changes and push them to your Git hosting service.
  • The source control contains the Elastic Path source.
  • The extensions/maven/settings.xml file is configured correctly for local development.