Getting the Elastic Path Commerce Source Code

Before you begin, ensure that you have the following items:

Access to your own Git based SCM (Source Code Management) tool
GitLab specific credentials on code.elasticpath.com
Access to the Elastic Path Maven repository

note

Maven credentials are required to access the Elastic Path Maven repositories. To request Maven credentials, open a support ticket.

For a description of the source code structure, including where to find third-party software dependencies, see Source Code Structure.

Access the Source Code Download

The Elastic Path Commerce source release package contains the source code and related artifacts that are required to build the Elastic Path Commerce platform.

The availability of the source code for each offering depends on your license agreement. You can access the source code with an active license agreement. To access versions 7.1.0 and after, you can download the code for your licensed product from code.elasticpath.com:

Elastic Path Commerce repository
Elastic Path CloudOps repository

note

This includes all CloudOps offerings, such as AWS and Kubernetes.
Elastic Path Education repository

If you have an active license agreement and cannot access the repositories, or have questions about products and patches from version 7.0.1 and earlier, see Product Support. Contact your Account Manager with questions about the product offerings available to you.

Setting up an SSH Key

Set up an SSH key for use with the Git repository. For instructions, see https://code.elasticpath.com/help/ssh/README.md.

Cloning the Git Repository

Navigate to https://code.elasticpath.com/ep-commerce/ep-commerce and clone the Git repository.
```
git clone https://code.elasticpath.com/ep-commerce/ep-commerce
```

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

Checking out a Release Branch

Each branch contains the source code for the release and all subsequent patches.

Check out the correct branch of a release version of Elastic Path Commerce.

git checkout -b release/<major>.<minor>.x

Where:

major indicates a major release version
minor indicates a minor release version
x indicates patch updates

tip

Enable Watch for the repository to be notified of any updates.

Pushing to Your Repository

Create a development branch in your local repository from the released version branch that you checked out.

The branch name depends on the SCM and your branch naming conventions. For example:
```
git checkout -b <my-org-ep-release-dev>
```
Add the Elastic Path Commerce repository to your own Git hosting service.
```
git remote add <remote-name> <my-git-repo-url>
```
Push the development branch to your own Git hosting service.
```
git push <remote-name> <my-org-ep-release-dev>
```