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.1.0 Developer Guide:
    1. Java 8 (JDK 1.8 64-bit) setup
    2. Maven 3.3.9 setup
    3. Configuring System Environment Variables

Unzip Source Release Packages

Elastic Path Commerce source code is delivered in the following release package:

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

Configure the Module's settings.xml File

The extensions module 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.

Re-version Modules for Development

Elastic Path release packages contain modules with RELEASE versions. Prior to starting development, the modules must be reversioned to SNAPSHOT versions using scripts provided in the devops module.

Tip:

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

To re-version modules for development:

  1. Make sure that:
    • Module directories have the same names as ones provided in source release packages.
    • The development branch is checked out.
  2. Run the following script to re-version code.
    cd <modules-parent-folder>
./devops/scripts/set-ep-versions.sh 701.0.0-SNAPSHOT 0.0.0-SNAPSHOT

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.