Skip to content

🛠️ Git & PyCharm Setup Guide

Follow these steps to set up your cloned GitHub project in PyCharm and ensure Git is properly configured.

0. Clone the Repository (if not done yet)

Use Git Bash or your terminal:

git clone https://github.com/your-username/your-repo.git

This will create a folder named your-repo.

1. Open the Project in PyCharm

  • Launch PyCharm
  • Select “Open” from the welcome screen (or go to File > Open...)
  • Navigate to the folder where your GitHub repo is cloned
  • Click Select Folder → choose This Window or New Window to open the project.

2. Make Sure Git is Recognised

  • Go to File > Settings (or PyCharm > Preferences on macOS)
  • Navigate to Version Control > Git
  • Ensure the path to Git executable is correct. Click Test to verify

3. Enable Version Control Integration

If PyCharm doesn't automatically detect Git:

  • Go to VCS > Enable Version Control Integration (only appears if Git isn't yet detected, otherwise you’ll see Git)
  • Select Git from the list and click OK

4. Check the Git Remote

To verify the remote origin (connection to GitHub):

  • Go to Git > Manage Remotes
  • Or open the Terminal and run:
git remote -v

You should see:

origin  https://github.com/your-username/your-repo.git (fetch)
origin  https://github.com/your-username/your-repo.git (push)

If it's missing, add it manually from the terminal:

git remote add origin https://github.com/your-username/your-repo.git

This ensures that your Git integration is ready to use for commits, pushes, and GitHub Pages deployment.