GitHub Setup

To be added to the current GitHub repositories, please Slack your project leader your GitHub username

Setting up SSH

To authenticate your local computer, you need a way to confirm your identity with GitHub. To do this, we recommend using SSH. You can read more here: https://www.cloudflare.com/learning/access-management/what-is-ssh/

To set up SSH, follow these steps

  1. Create a SSH key if you don't already have one. Open a terminal and run the following. Please DO NOT USE COMMAND PROMPT.

    1. cd ~/.ssh

    2. ls

    3. Check if you have a file that ends in .pub. Examples include id_rsa.pub or id_ed25519.pub.

    4. If you do, run cat <pubkey file> and copy the key

    5. If you don't have a file like that, please run ssh-keygen -t ed25519 to create a SSH key and then copy the key.

  2. Navigate to GitHub's interface and click on your profile picture, then click SSH and GPG Keys. Add your SSH key you copied above into GitHub

Cloning a repository

Navigate to the repository and click the green "clone" button. Select "SSH" as the tab option and copy the link:

Then navigate to a suitable location to clone the repository, such as ~/Documents and run:

git clone <ssh link>

Congrats, you've clone the repository! Now just navigate into the repository and run VS Code!

Last updated