Skip to content

Connecting your project to GitHub

Before you start creating a project that you want to connect to a project in an external repository, log in to your GitHub account and initiate the required project to prepare the required values for copying and inserting in the platform wizard.

  1. Log in to your Constructor Platform account at https://research.constructor.tech/.
  2. Go to My project.
  3. Click  New project.
  4. Enter the project name and enable the Connect to existing Git toggle.

  1. Click Save. The connection form will open.

  1. Copy the SSH URL from your Git project:
    1. In a new browser tab, log in to your GitHub account.
    2. In your account menu, go to Your repositories
    3. Click the required repository to open it.
    4. Go to <>Code and switch to the SSH tab to copy the required SSH URL value for inserting in the platform wizard.

InformationFor a newly created repository, the SSH URL is available on the setup page:
  1. Switch back to the platform tab and specify these parameters:
  • Git repository SSH URL — paste the SSH URL that you copied from your GitHub repository.

  • Branch name — enter the branch name according to the branch in your GitHub repository (the default value is main). The project workflow in Constructor Platform will work only with this branch. It cannot be changed after the project creation.

  1. Copy the value from Public SSH key to add in your Git project.

  2. Save the SSH key from the platform to Git:

    1. Switch to the tab with your GitHub repository.
    2. In your account menu, go to Settings.
    3. Go to SSH and GPG keys
    4. Click New SSH key and paste thecopied public key value. 
    5. Click Add SSH key.
  3. Switch to the platform tab and copy the Web-hook URL value. This settings synchronizes the content of the project in the platform with the external Git repository and allows all the users who share the project get data updates without delays.

  4. Add a webhook to your Git repository:

    1. Switch to the tab with your GitHub repository.
    2. In the repository, go to Settings > Webhooks
    3. Click Add webhook and insert the copied value to Payload URL, check that the event to trigger is set to Just the push events.
    4. Click Add webhook.
  5. Switch to the platform tab and click Create. Now the Git repository is connected to your project in the platform.