Cloning the Git Repository

You'll need access to the following Git repository: https://github.com/Synergex/IntegrationPlatform. This is a PRIVATE repository, so before you can access it you'll need to be specifically granted access to it. If you don't already have a GitHub user account, create one now (the free tier is fine) and then request access by providing your GitHub username to Steve Ives or Jeff Greene.

IMPORTANT: The Git repository includes the use of Git submodules, which must be taken into account when cloning the repository. Please follow the instructions below carefully.

Configuring SSH Access to GitHub

If you would like to access GitHub via SSH instead of HTTPS, follow the instructions in Setting up SSH access to GitHub.

Location

We recommend cloning the repository into a folder that does not include spaces in the path. We've tried to ensure that hard-coded paths don't exist in checked-in files, but that is not completely possible, so for maximum compatibility, we recommend cloning the repository into C:\DEV\SYNERGEX\IntegrationPlatform.

Cloning the Repository

NOTE: Because the Git repository includes submodules, you MUST follow a special process when cloning a new working copy. If you fail to follow these instructions, your solution will not build.

To clone using HTTPS:

git clone --recurse-submodules https://github.com/Synergex/IntegrationPlatform.git

To clone via SSH:

git clone --recurse-submodules git@github.com:Synergex/IntegrationPlatform.git \<location\>

Once you have cloned the repository:

cd IntegrationPlatform
git submodule update --init --recursive
git submodule foreach "git fetch && git checkout master && git pull --ff-only"

The repository also includes a batch file that performs these same steps, so you can achieve the same results as follows:

cd IntegrationPlatform
UpdateSubModules