Code Monkey home page Code Monkey logo

learn-git-milestones's Introduction

Git Milestones

An introduction to Git and Github.

Instructions

Complete each task below, creating files and adding content inside the completions table when prompted with a ✏️ - After you finish, celebrate your Git proficiency! 🙌

  • Follow the instructions. Review course content as needed.
  • Sometimes I share the command you need, but you may need to read the documentation.
  • This milestone is for multiple classes. Insert your own class name when prompted, for example: critical-web-design

1. Install Git

⚠️ Complete the command line crash course to prepare to install Git on your machine.

Windows

Download and install Git from gitforwindows.org. This includes Git BASH. The default settings should work fine.

Mac

Install Git using Homebrew using these instructions:

  1. Copy and run this whole line to Install the homebrew package manager. If prompted to "Install Command Line Developer Tools?", choose yes.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  1. To confirm installation:
brew --version
  1. Then install git using homebrew:
brew install git

2. Configure Git

  1. This will verify Git is installed by outputing the current version.
git --version
# -> git version 2.38.1
  1. Check to see if Git is already configured. If this returns "No such file or directory" or you want to update the file then continue to the next step.
cat ~/.gitconfig
  1. Add your name (replace with your information, press return after each line)
git config --global user.name "Your Name"
  1. Add your email
git config --global user.email [email protected]
  1. Set the default branch to main
git config --global init.defaultBranch main
  1. Set pull to merge (not rebase)
git config --global pull.rebase false
  1. Confirm your global settings worked
cat ~/.gitconfig

3. Markdown Introduction

Markdown is a lightweight markup language for creating rich text.

  • It has a simple syntax similar to HTML
  • It is the standard language for formatting README files (what you are currently viewing!)
  • Files use the .md extension and can be edited with any plain text editor (e.g. VS Code).
  • Preview using the VS Code or the Markdown Viewer
Markdown HTML Rendered Output
[link](https://davidson.edu) <a href="https://davidson.edu">link</a> link
**bold text** <b>bold text</b> bold text
*italicized text* <i>italicized text</i> italicized text
`code` <code>code</code> code
![text](assets/img/icon.png) <img alt="text" src="assets/img/icon.png"> text

Now you know basic Markdown! 🎉

The following instructions will help you learn Git, editing this .md file in the process. Use the github markdown cheatsheet to check your syntax.

Other Markdown tools

4. Fork this repository

Create a Github account and make your first commit on Github.com

  1. Create a Github account
  2. Fork this learn-git-milestones repository (click the Fork button, top right).
  3. ✏️ Edit this README.md file (click the pencil icon on the Github.com page) and add your 1st favorite emoji to the Completions table, in the Completed column in appropriate row in the completions, below.
  4. Commit changes to README.md to the main branch with the message commit #1 from Github.com.
  5. ✏️ Use Markdown documentation to add a link in completions. The link text should be the same as the commit message, and the url should point to the Github.com page showing the above commit.
  6. ✏️ Tables can be a little tricky in Markdown. Find a good link explaining how to use markdown tables. Paste the link in the Completions table.
  7. View the commit history and confirm your edits
  8. ✏️ What does log do? Add your answer to completions.

5. Git Workflow > Github Desktop

Perform a basic Git workflow using Github Desktop. This is the first of four different interfaces to give you practice with Git. You've already forked and made a commit on Github.com so let's move to Github Desktop ...

Setup

  1. Install Github Desktop
  2. Connect your Github account in Github Desktop
  3. In Github Desktop, clone the fork (you made above) learn-git-milestones ...
  4. File > Clone Repository > Github.com and select it ...
  5. Local Path: Click "Choose" and add a new folder on your computer. This will be the base folder for your work in this class (e.g. critical-web-design, game-development )
  6. Click "Clone" to make a local copy

Open in VS COde

  1. Install VS Code) and connect your Github account
  2. Open the repo in VS Code: Repository > Open in VS Code (see preferences to change your editor)
  3. ✏️ In VS Code, edit this README file and add your 2nd favorite emoji to completions.
  4. In Github Desktop, view/confirm your edits to the README file on the Changes tab
  5. ✏️ Commit your changes directly to the main branch with the message commit #2 from Github Desktop.
  6. Find a link to the above commit on Github.com and use VS Code to add it to completions. Commit your change.
  7. Click Push origin to push your new commit to remote repo
  8. Confirm the changes to the README file were pushed: Choose Repository > View on Github
  9. Click on the README file and then click on History to see the history of this file

6. Git Workflow > Command line

Some folks use the CLI as their default tool for editing and publishing source code, but Github Desktop makes it much easier.

Setup

  1. In Github Desktop, ensure you are currently in the learn-git-milestones repo you cloned above.
  2. Click Repository > Open in Terminal ("Bash" in Windows?)

Use the CLI to navigate directories

  1. List files in this directory: ls
  2. List files in this directory, including hidden: ls -la
  3. Confirm the existence of the .git directory (where Git versions and config are stored)
  4. ✏️ View your current working directory and copy the full path: pwd
  5. Open this README file in VS Code and paste that path in completions.

Use Git on the CLI

  1. Confirm your name and email is correct in the Git config
  2. View the status of your repo: git status
  3. View the changed files of your repo: git diff
  4. Add all changed files to the staging area git add .
  5. View the status of your repo git status to confirm it has been staged
  6. ✏️ Commit your changes with the message commit #3 from CLI. Add a link to this commit to completions.
  7. Use git push to push those changes to your remote repo

You've used most of these already through a GUI (e.g. git status, git add, git commit, git push) ...

7. Git Workflow > VS Code

  1. From Github Desktop, you can open the learn-git-milestones repo in VS Code using: Repository > Open in VS Code
  2. ✏️ In VS Code, edit this README file and add your 3rd favorite emoji to completions.
  3. ✏️ Create a new file hello.txt, add some text and save it.
  4. Display the Git panel (click the small Git button at the bottom right).
  5. Select on your file(s) in Unstaged changes and confirm your changes match what you expect to see
  6. Double click on each file with changes to stage them
  7. ✏️ Commit your changes directly to the main branch with the message commit #4 from VS Code. Add a link to this commit to completions.

8. Create a new repository

  1. ✏️ In Github Desktop, create a new repository with the name: first-website
  2. Make sure the repository is public not private
  3. Local Path: Click "Choose" and create a new folder first-website inside the <your-class-name-here> folder you made above
  4. Click Create Repository
  5. This should now be your class folder's directory structure.
<your-class-name-here>
|-- first-website
|-- learn-git-milestones
  1. Open your new repository in VS Code (with Github Desktop or drag the first-website project folder onto the VS Code icon in your dock)
  2. ✏️ Add a README file: README.md
  3. ✏️ In the README write your name and the date
  4. ✏️ Use some Markdown tags
  5. ✏️ Commit your changes and add a link to this repo to completions.

9. Publish a web site with Github Pages

Github Pages is a free and easy way to host a website from your repository.

  1. ✏️ Create a file called index.html in your new repo and add the following code
<!DOCTYPE html>
<html>
<head>
<title>My first github.io website</title>
</head>
<body>

<h1>Hello world!</h1>
<p>🙌</p>

</body>
</html>
  1. On Github.com, go to your repo > Settings > Pages
  2. Select the main branch source and click save
  3. Do not use a theme. Start from scratch
  4. Visit your project site at http://username.github.io/first-website
  5. Update your project, push a new commit, and confirm your updates (note: deployments sometimes take a bit)
  6. ✏️ Paste this link to completions.

10. Turn in this Assignment

Now that we have basic Git commands out of the way use Git to create and turn in your assignment ...

  1. Complete all of the items on this README, making sure all the rows in the "Completed" column contain your information below.
  2. Test your file(s) in a web browser
  3. Commit and push the files to Github
  4. Paste the github.io link into the appropriate Moodle forum

Completions

Item # Description Completed
4a 1st Favorite emoji ADD_TEXT_TO_THIS_COLUMN
4b Link to commit #1 from Github.com
4c Link to markdown tables docs
4d What does log do?
5a 2nd Favorite emoji
5b Link to commit #2 from Github Desktop
6a Full path to your working directory
6b Link to commit #3 from CLI
7 3rd Favorite emoji
8 Link to commit #4 from VS Code
9a Link to first-website github.com repo page
9a Link to first-website github.io "project site"

Resources

Here are some popular tutorials/guides. You should still look for other ones that you might like better!

Git Advanced

That is all that is required for this milestone. See the ADVANCED.md file if you would like to continue learning Git.

Credits

Thanks to Jesse Farmer for inspiring this milestone assignment.

learn-git-milestones's People

Contributors

omundy avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.