GitHub Desktop Tutorials

Installing and setup of GitHub Desktop Application

What is Git?

"It is a version control system used for software development." -Wikipedia-

What is GitHub?

It is a company that hosts Git repositories. Developers use it store different projects they are working on.

Installing GitHub Desktop

  1. Make sure you have created a GitHub account, if not click here to use that tutorial and set up an account.
  2. Download GitHub Desktop by clicking the following link.

    3. Note: Instructions are available for Mac and Windows

  3. Next, we need to authenticate your GitHub account. Click here and follow instructions.

    4. Note: Ignore any steps stating GitHub Enterprise.

  4. While still in Preferences, click the gear icon titled "Advanced"
    5. Gear icon
  5. Review the fields labeled "Git Config". It should have your name and email address used to register.
    6. Example of name and email setup.
  6. If correct, then close "Preferences" or change the information.

Has your team created a repository for your project?

Create a Repository for Your Project

    Note: Only one team member needs to create a repository for your team project. The team will clone a copy throught their own GitHub Desktop.

  1. In the top left-hand corner of the GitHub Desktop, click the plus icon.
    2. Image of plus icon in the top left-hand corner of window.
  2. Choose Create
    3. Popup shows a two fields to enter name of project and where to save project locally.
  3. In the name field type your projects name.
  4. On the right of Local Path, click "Choose" and pick where you want your local copy to be saved.

    5. Note: I recommend creating a directory to store all your repositories for future projects. I recommend a directory named GitHub.

  5. Click "Create Repository". This saves a local copy to your computer.
    6. Example of a project name and location.
  6. Next, we will publish your local copy to Github.com. Click the button on the right-hand side that says "Publish".
    7. Example of a project name and location.
  7. Review pop-up and make sure the project name is correct and click "Publish Repository".
    8. Shows a summary of project info and button to publish repository.
  8. On the right-hand column, your new project title displays under Github.
    9. Shows project now stored in Github website

Adding your Team Members to the Project

  1. On the right-hand column, right-click your project's name and select "View on GitHub".
    2. Shows how to launch github.com from desktop application.
  2. This will launch the project in Github.com.
  3. Under the name of the project, click the "Settings" tab.
    4. Settings option is the right of Graphs.
  4. On the left-hand side of Settings, click the button "Collaborators".
    5. Collaborators is on the center left-hand column.
  5. Add all your team members to the project. Either type their username or email and click "Add Collaborator".
    6. Image of email being entered to add collaborator.

Uploading your First File

  1. Create a test HTML page with your favorite text editor
  2. Save the file
    3. Image a text file with basic html.
  3. Once saved, launch GitHub Desktop application.
    4. Desktop application showing file ready to commit to repository.

    Note: Notice the file saved is now showing in our GitHub application. This doesn't mean it is uploaded to the repository yet. It is waiting to be commited to the site.

  4. In the summary input field, type "Test Commit"
  5. In the description input field, type "This is my initial commit."
  6. Click "Commit to Master"
    7. Example of summary for commit.
  7. On the upper right-hand side, click Publish.
    8. Publish button is on the upper right-hand corner of the applicaiton.

    Note: Once published the file created is stored on GitHub's repository.

Cloning your Team Project

    Note: Make sure someone on your team has created a repository for your project before continuing.

  1. In the top left-hand corner of the GitHub Desktop, click the plus icon.
    2. Plus sign on the top left-hand side.
  2. Select "Clone"
  3. Type the name of your project.

    4. Note: Since another team member created the repository, there username will show in from of the project name.

  4. Click "Clone Repository"
    5. Showing how to find a repository via the project name.
  5. A pop-up appears asking where to save project locally.

    6. Note: I recommend making a directory called GitHub to store your project. That way you can store of projects in one directory.

    A pop-up asks where to save cloned repository.
  6. Now a copy of your team project is saved locally to your desktop.