Announcement: You can find the guides for Commerce 7.5 and later on the new Elastic Path Documentation site. This Developer Center contains the guides for Commerce 6.13.0 through 7.4.1.Visit new site

This version of Elastic Path Commerce is no longer supported or maintained. To upgrade to the latest version, contact your Elastic Path representative.

Prepare Source Code

Prepare Source Code

Overview

This page describes how to prepare Elastic Path source code for use by your project. The diagram below shows the steps.

Starting Construction Prepare Source

Setup local build environment

You will need a working Java build environment on your local computer to prepare the source code.

  1. Setup your build environment as described in the following sections of the Core Commerce 7.0.1 Developer Guide:
    1. Java 8 (JDK 1.8 64-bit) setup
    2. Maven 3.3.9 setup
    3. Configure your System Environment Variables

Unzip source release packages

EP source is delivered in the following release package:

Release Package Contents
EP-Commerce-7.0.1.zip Core Commerce, Cortex
  • Unzip the contents of the release package into your project source folder.

Configure the project settings.xml

The extensions project has a maven/individual-settings.xml you will use.

  1. Change EP_REPOSITORY_USER and EP_REPOSITORY_PASSWORD to the credentials used for connecting to our public Nexus.
    <servers>
        <server>
            <id>ep-public</id>
            <username>EP_REPOSITORY_USER</username>
            <password>EP_REPOSITORY_PASSWORD</password>
        </server>
        <server>
            <id>ep-cortex</id>
            <username>EP_REPOSITORY_USER</username>
            <password>EP_REPOSITORY_PASSWORD</password>
        </server>
        <server>
            <id>ep-commerce-engine</id>
            <username>EP_REPOSITORY_USER</username>
            <password>EP_REPOSITORY_PASSWORD</password>
        </server>
        <server>
            <id>ep-accelerators</id>
            <username>EP_REPOSITORY_USER</username>
            <password>EP_REPOSITORY_PASSWORD</password>
        </server>
    </servers>
  2. Make any changes required for your project environment.
  3. Commit the changes to source control.
  4. Rename individual-settings.xml to settings.xml copy it to your ${user.home}/.m2 directory.

Reversion projects for development

EP release packages contain projects with RELEASE versions. Prior to starting development, the projects must be reversioned to SNAPSHOT versions using scripts provided in the devops project.

Tip:

On Windows, use either Git Bash, MinGW, or Cygwin to run the script.

To reversion projects for development:

  1. Make sure that:
    • All projects have a common parent folder.
    • Project folders have the same names as ones provided in source release packages.
    • The development branch is checked out for each source repository.
  2. Run the following script to reversion the commerce-manager, commerce-engine, devops and extensions projects. 
    cd <projects-parent-folder>
         ./devops/scripts/set-ep-versions.sh 700.1.0-SNAPSHOT 0.0.0-SNAPSHOT commerce-engine extensions commerce-manager devops
  3. (Optional) Run the following script to reversion the cortex-ep-integration project. If you don't reversion this project, then the cortex-ep-integration release binaries will be retrived from the Elastic Path Nexus repository. You will need to reversion the project to a SNAPSHOT version if you wish to make changes to it. 
    cd <projects-parent-folder>
      ./devops/scripts/set-cortex-ep-integration-version.sh 700.1.0-SNAPSHOT 0.0.0-SNAPSHOT cortex-ep-integration extensions

Set up local Developer environment

Follow the instructions at Setting up your Developer Environment to configure, build and run Elastic Path Commerce in a command line environment.