GitHelp

From EECH Central
Jump to: navigation, search

This page shows you the requirements for accessing the EECH source code, which is located in a Git repository on CodebaseHQ

Git

You will need a Git client, for example TortoiseGit. Note that you also need to install msysgit 1.6.1 or above before you install TortoiseGit!

CodebaseHQ Account

As stated on the Development page, in order to be able to create your account, we need your firstname, lastname (these are required by the hosting software), your desired username and a valid email address. Once an account was created, an activation email will be sent to the address you provided. This mail includes a link which will activate your account once you clicked on it and submitted a password (see image on the right).
The codebase signup page

SSH Keys

Once you have activated your account and as a requirement in order to clone the repository you have to provide a SSH key.

Creating and uploading the key

TortoiseGit should install a copy of the "PuttyGen" program in the "bin" subfolder of its installation directory. Use this program to create a SSH2-RSA 1024 bit keypair (the default settings should be ok, just press the "Generate" button). Once this is done, you may paste the generated public key into the mask in your webbrowser (you reach this by clicking the "Add new SSH Public Key" link in your CodebaseHQ profile). Save the private key into a 'ppk' file on your development machine (you will need this one later on).
Puttygen just created a key; the public key is marked and can be copied directly into your browser
Adding a public SSH key
The SSH key entry mask in your profile

Please note that you can generate and add the SSH key after the initial account activation.

Cloning a repository

Once everything is set up, how do you get the code? First, you need to get a link to the branch you want to retrieve. You can do this in CodebaseHQ by first selecting the EECHMain project (image 1), then the eechdev repository (image 2). You will find the link to the repository in the upper right corner (image 3). Copy it to the clipboard.

Image 1: The dashboard on first login
Image 2: The EECHMain project
Image 3: The eechdev respository

On your development machine, create an empty folder. Now, right click on this folder node (or somewhere in it) and select "Git Clone..." from the context menu (see image 4). A dialogue like shown in image 5 should appear. After the repository was cloned, Windows Explorer overlay the normal file/folder icons with custom icons showing the file status (up-to-date, modified, conflicted etc), see image 6.

Image 4: The TortoiseGit "clone" context menu
Image 5: Clone settings
Image 6: A Git repository

In the "URL" box, copy the link to the code repository you copied earlier. You may verify that the path in the "Directory" box is correct. Finally, make sure that the path to the SSH private key you created earlier is correct. If you now click on "OK" Git should start retrieving the code. Please note that as Git retrieves the entire repository this may take a while.