Skip to content

Latest commit

 

History

History
105 lines (77 loc) · 4.41 KB

github.md

File metadata and controls

105 lines (77 loc) · 4.41 KB

Setup Git and GitHub

Having a GitHub account and knowing the basics of committing and pushing changes are mandatory for this academy.

⚠️If you don't have a GitHub account, complete the following steps:

  1. Sign up for a GitHub account if you don't already have one.

⚠️If you have a GitHub account but git is not set up in your system, complete the following steps:

  1. Checking for existing SSH keys
  2. Generating a new SSH key and adding it to the ssh-agent
  3. Adding a new SSH key to your GitHub account
  4. Testing your SSH connection

Setup your Workspace Repository

The workspace directory/repository is where you will place everything you are working on, solve exercises, make changes to files, etc. In this academy that is a requirement as it is how you will make your work available to us.

Creating the Workspace

  1. Log into GitHub
  2. Create a new private GitHub repository called batch6-workspace, see Creating a new repository. IMPORTANT The repo MUST be named batchX-workspace where X is the current batch number! If you name it anything else, you will be unable to submit any of your work!
    1. You need to explicitly select Private - This is your work and nobody else's. You will be graded based upon the merits of what you are able to do here so this should not be open to the world while you are working on it.
    2. Initialize with a README. This is mostly just so that you don't initialize an empty repo.
    3. Add a Python .gitignore. This step is insanely important. If you don't do this, you may end up checking things into the repo that make it un-gradeable by our grading system. ADD THE .gitignore PLEASE!!!! <--- 4 * ! isn't enough

Create Repository

Add a Deploy Key to your Repository

Since the repository is private you will have to explicitly give access so that our grading system can fetch the repository. To do this you will be adding a deploy key to the repository, which we provide to you in our Portal.

  1. Head on to the Portal
  2. Log in with your GitHub account
  3. Go to your profile and copy the deploy key (including the ssh-rsa part) Profile
  4. Go back to the repository you have just created
  5. Go to Settings > Deploy Keys
  6. Click "Add deploy key" (no need to grant Write Access)
  7. Give it a recognizable name like "grader" and paste the key from the Portal Deploy keys

Cloning the Workspace

  1. Open a Terminal or Git Bash, the next steps are on this terminal

  2. Clone your <username>/batchX-workspace repository

    If you're not sure where to clone the repository in, you can create a ~/projects folder, and clone it there. Don't forget to replace the X with your corresponding batch number. For example, for batch 6, your repository should be batch6-workspace.

  3. Clone the students repository If you have your ssh keys set up as instructed:

git clone [email protected]:<username>/batchX-workspace.git

else

git clone https://github.com/<username>/batchX-workspace.git

Get the Learning Material

You will be cloning the batchX-students repository.

for batch6 this will be https://github.com/LDSSA/batch6-students

All of the learning material you need will be made available on this repo as the academy progresses.

  1. Open a Terminal or Git Bash, the next steps are on this terminal
  2. Clone the students repository batch6-students
git clone https://github.com/LDSSA/batch6-students.git

Or if you have your ssh keys set up:

git clone [email protected]:LDSSA/batch6-students.git