Introduction
Moving a project from your local machine to a remote repository like GitHub is a fundamental skill for any developer. This guide breaks down the process of initializing a Git repository, setting up SSH for secure connections, and pushing your first project to GitHub. Think of Git as your project's meticulous archivist, tracking every change, while GitHub acts as its secure, accessible online vault.
Setting Up Your Local Project with Git
The journey begins with creating a project directory and initializing Git within it. You can use Git Bash (or your terminal of choice) for this.
mkdir Kenya-Hospital-Records-Analysis
cd Kenya-Hospital-Records-Analysis
git init
The git init command transforms your existing directory into a Git repository. It creates a hidden .git subdirectory that contains all the necessary repository files—the metadata for your project. From this point, Git will start tracking changes.
Staging and Committing Your Changes
Before you can push your project, you need to tell Git which files to track and then save those tracked files as a snapshot in time. This is done in two steps: staging and committing.
First, create some files for your project. For example, you might create a README file and a Python script.
echo "# Kenya Hospital Records Analysis" >> README.md
echo "print('Hello, World!')" >> main.py
Next, use git status to see which files are untracked.
git status
To add these files to the staging area, use git add. You can add individual files or all files using a dot (.).
git add .
Once staged, you commit them with a descriptive message using git commit.
git commit -m "Initial commit with README and main script"
This commit represents the first saved state of your project. You can view your commit history using git log.
Setting Up SSH Keys for GitHub
To securely connect your local machine to GitHub without repeatedly entering your username and password, SSH (Secure Shell) keys are essential. You'll generate a pair: a private key (kept secret on your machine) and a public key (shared with services like GitHub).
First, check if you already have SSH keys. In Git Bash, run:
ls -al ~/.ssh
If you see files named id_rsa.pub or id_ed25519.pub, you likely have existing keys. If not, generate a new pair. It’s recommended to use Ed25519 keys:
ssh-keygen -t ed25519 -C "your_email@example.com"
Press Enter to accept the default file location and optionally set a passphrase for extra security. This creates id_ed25519 (private) and id_ed25519.pub (public) in your ~/.ssh directory.
Adding Your SSH Key to GitHub
Now, you need to add your public key to your GitHub account. Copy the public key to your clipboard:
clip < ~/.ssh/id_ed25519.pub
Go to your GitHub account settings. Navigate to Settings > SSH and GPG keys. Click New SSH key. Give it a descriptive title (e.g., "My Work Laptop") and paste your public key into the 'Key' field. Save the key.
Test your connection by running:
ssh -T git@github.com
You should see a message confirming your successful authentication.
Creating a Remote Repository on GitHub
Navigate to GitHub and create a new repository. Click the '+' icon in the top-right corner and select New repository. Give it a name (e.g., Kenya-Hospital-Records-Analysis), choose whether it's public or private, and optionally add a README, .gitignore, and license. Click Create repository.
Connecting Your Local Repository to GitHub
GitHub will provide you with a remote URL for your new repository. This URL typically looks like git@github.com:your-username/your-repo-name.git (for SSH) or https://github.com/your-username/your-repo-name.git (for HTTPS).
Back in your local Git Bash, add this remote repository using the git remote add command. Replace origin with a name for your remote (origin is conventional) and use the SSH URL.
git remote add origin git@github.com:your-username/Kenya-Hospital-Records-Analysis.git
Verify that the remote has been added correctly:
git remote -v
Pushing Your Project to GitHub
Finally, push your committed changes from your local repository to the remote repository on GitHub. The command git push is used for this, along with the remote name (origin) and the branch name (typically main or master).
git push -u origin main
The -u flag sets the upstream branch, meaning future pushes and pulls from this branch will default to interacting with origin/main. After this command, your project will be visible on your GitHub repository page.
Conclusion
You've successfully taken a local folder, initialized it as a Git repository, committed your initial work, set up secure SSH access to GitHub, and pushed your project to the remote. This foundational workflow is critical for collaboration, version control, and deploying your code. Mastering these steps opens the door to more complex Git operations and team-based development.