Git Tutorials

Appearance

Quick Start ​

Time to read:
3 minutes

Hey, you already read this course!

Your next step is to get the course repository that will give you the tools to go through each activity.

What you need ​

Requirements to follow this course are very minimal:

  • a POSIX shell
    • Windows: GitBash
    • macOS: default is zsh, but you can use built-in Bash (or install a more recent one)
    • Linux: default shell depends on your distribution, but Bash is widely used.
  • Git is installed on your workstation
    • Windows: I advise to use winget to install it.
    • macOS: I suggest to use Homebrew package manager for the setup.
    • Linux: use the package for your disptribution.
  • You preferred code editor: vi, emacs or VSCode. Use the one that you prefer and were you feel comfortable with.

What you should know ​

I assume that:

  • You have an code editor of choice, or you just use VS Code.
  • You have at least basic notion of a Unix shell, whether it's Bash, Zsh or any other.
  • You are already at ease with simple Git commands to clone a repository, change branch, commit files, pull qnd push changes.

And that should be enough to start this course!

Get this course ​

Repository

git-course

This Git course is hosted on GitLab.

To get a local copy, open a shell and go to the folder where you want to work. Then enter the following command:

bash
git clone https://gitlab.com/sgamel-projects/git-course.git

Build the course content ​

The course repository contains activities but also the entire content of this website.

If you ever need to work offline, or simply want to check how this was built, nothing stops you to do so.

Go to the clone's folder and install dependencies:

bash
yarn install

Now you can build and preview the course with this command:

bash
yarn serve

This will compile the course material and run a minimal server to browse the content.

yarn serve will build the documentation and serve it with Vitepress integrated web server. If you ever plan to contribute to this course, you can run yarn docs:dev to not only serve the course content, but also watch course source files and recompile live.