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.

Build the Source Code

Build the Source Code

Checkout Source Code

To checkout a local copy of the Elastic Path source code from your source control repository:
  1. Create a folder to contain the Elastic Path source.
  2. Checkout the following Elastic Path projects from the source control repository to your local source folder:

    • commerce-engine

    • commerce-manager

    • cortex-ep-integration
    • extensions

Configure Maven Settings.xml

You need to configure your local copy of the settings.xml, which is available in the extensions project before you build the source code.

To create a local Maven repository, which will contain the Elastic Path build artifacts you build:
  1. With the command line, create a .m2 directory in your user home folder. In Windows, the command is: 
    mkdir C:\Users\<YourWindowsUser>\.m2
  2. Copy settings.xml from the \extensions\maven source directory to your .m2 directory.
  3. Modify settings.xml values to match your local developer environment. Pay attention to:
    Property Profile Definition
    epdb.reset_user mysql-dev-db The DB account with administrative permissions that can drop and create databases and users in your local database.
    epdb.reset_password mysql-dev-db The password for epdb.reset_user.
    ep.local.asset.path - The path to your local /extensions/assets/ext-assets/src/main/assets source directory
    ep.smtp.host - Your SMTP Server
    Tip:

    If these property values do not exist in the settings.xml, then your source code has likely not been prepared according to the Starting Construction Guide and you will not be able to build and deploy the Elastic Path Web Applications.

Build Commerce Engine

  1. With the command line, navigate to the commerce-engine folder in your source directory.
  2. Enter the following Maven command.
    mvn clean install -DskipAllTests
    The -DskipAllTests stops Maven from executing any unit and integration tests, but does not stop them from building the tests. For more information on assets, see Managing Assets. For more details on the Maven arguments, see Elastic Path Maven Commands.

Build Cortex Resource Integration

After building the Commerce Engine, you can build the Cortex Resource Integration project.

  1. With the command line, navigate to the cortex-ep-integration folder in your source directory.
  2. Enter the following Maven command:
    mvn clean install -DskipAllTests

Build Commerce Manager

After building the Commerce Engine, you can also build the Commerce Manager.

  1. With the command line, navigate to the commerce-manager folder in your source directory.
  2. Enter the following Maven command:
    mvn clean install -f cm-invoker/pom.xml -DskipAllTests

Build Extensions

Finally, after building the other projects, you can build the Extensions project.

  1. With the command line, navigate to the extensions folder in your source directory.
  2. Enter the following Maven command:
    mvn clean install -DskipAllTests