Documentation

Documentation for the BuildWithGit platform with an overview, setup guidance, challenge workflow, images, and a video walkthrough.

1. Getting Started

Install Git locally

  1. Install Git and verify with git --version.

2. How to Complete Challenges

Challenges are completed entirely with Git by initializing or cloning the prepared repository, making focused commits to meet objectives, and pushing changes for automatic validation.

2.1 Download or copy the script

Begin by copying the command or downloading the prepared .git and setting it manually

Options to download the .git directory or copy the bootstrap script
Starting with a download or a one-line script

2.2 Setting up the editor

Use a your favorite code editor and do some changes first then type

  1. git add .
  2. git commit -m "setup"

you will be prompted with this ui, type your email and password

Editor setup
Enter your email and password

Once you enter correct email and password you will be displayed this

Editor setup
Enter your email and password

2.3 How to complete the challenges

Just commit with message to check your code if it is correct you will be displayed this, if correct

Step-by-step flow of completing a challenge with commits and pushes
Correct solution

if not correct

Step-by-step flow of completing a challenge with commits and pushes
Incorrect solution

2.4 What happens when the challenges are done

When you complete all the challenges just see the website, it would show that you have completed the challenge

If you did the learn page challenges it should display this

Completion state with dashboard progress and status indicators
Learn page challenge done

If you did the challenges page challenge, it would display this as progress

Completion state with dashboard progress and status indicators
challenges page

3. Video walkthrough

Prefer a quick demo? Watch the short overview video to see setup and completion flow end-to-end.

Open the BuildWithGit setup walkthrough video

Thank you

Thank you for choosing BuildWithGit — the support is truly appreciated, and it helps continuously improve the learning experience.