How To Set Up Github: A Step-By-Step Guide

by Devop · 16/08/2024

Starting with GitHub can seem tough, but it’s easier step-by-step. This guide will help you create a GitHub account, set up Git, and start your first project. Whether you’re new to coding or just new to GitHub, you’ll find everything you need here.

Table of Contents

Key Takeaways

Creating a GitHub account is the first step to using GitHub.
Choosing the right plan is important for accessing the features you need.
Setting up two-factor authentication (2FA) adds an extra layer of security.
Customizing your profile helps others know more about your work.
Installing Git on your computer is essential for managing your code locally.

Creating Your GitHub Account

Navigating to GitHub

First things first, open your web browser and head over to GitHub. You’ll see a Sign Up button right on the homepage. Click it to get started.

Filling Out the Sign-Up Form

In the GitHub sign-in popup, click on Create an Account. You’ll need to enter a username, your email, and a password. Make sure your password is strong and unique to keep your account secure.

Verifying Your Email

After filling out the form, GitHub will send a verification email to the address you provided. Open your email inbox, find the email from GitHub, and click the verification link. This step is crucial to unlock all the features GitHub has to offer.

Pro Tip: Always use a valid email address that you have access to, as this will be your primary means of communication with GitHub.

Choosing the Right GitHub Plan

GitHub Free vs. GitHub Pro

When starting with GitHub, you have two main options: GitHub Free and GitHub Pro. GitHub Free is perfect for personal projects and small teams. It offers unlimited public and private repositories, but with some limitations on features like advanced code review tools and insights.

On the other hand, GitHub Pro provides more advanced features, including required pull request reviewers, code owners, and more. This plan is ideal if you need more control and insights into your projects.

Upgrading Your Plan

If you start with GitHub Free and find you need more features, upgrading to GitHub Pro is simple. Just head to your account settings and select the plan that fits your needs. You can also explore GitHub Enterprise if you’re working in a larger organization and need advanced security and compliance features.

Understanding GitHub Enterprise

For businesses and large teams, GitHub Enterprise offers robust features tailored for enterprise needs. This includes advanced security, compliance, and deployment options. You can choose between GitHub Enterprise Cloud and GitHub Enterprise Server depending on your deployment preferences.

To help you decide which choice is best for your enterprise, see "choosing an enterprise type for GitHub Enterprise Cloud" in the GitHub Enterprise Cloud documentation.

GitHub Enterprise is designed to support DevSecOps practices, ensuring your development, security, and operations teams can collaborate seamlessly. If you’re considering a switch from another platform, like GitLab Premium, GitHub Enterprise provides the tools and support to make the transition smooth.

For more details on why your business should choose GitHub, check out the "about GitHub for enterprises" section in the GitHub documentation.

Setting Up Two-Factor Authentication

Why Use Two-Factor Authentication

Two-factor authentication (2FA) adds an extra layer of security to your GitHub account. It’s a must-have to keep your account safe from unauthorized access. When you enable 2FA, you’ll need to verify your identity using a second method, like a code from an app or a security key, in addition to your password.

Configuring 2FA

Setting up 2FA on GitHub is straightforward. Follow these steps:

Go to your GitHub account settings.
Click on ‘Security’ in the left sidebar.
Under ‘Two-factor authentication’, click ‘Enable two-factor authentication’.
Choose your preferred method: an authenticator app or a security key.
Follow the on-screen instructions to complete the setup.

Once configured, you’ll need to verify new devices when signing in.

Managing Backup Methods

It’s crucial to have backup methods in case you lose access to your primary 2FA method. GitHub allows you to generate recovery codes, which you should store in a safe place. You can also add a secondary authentication method, like another authenticator app or a different security key.

Always keep your recovery codes secure and accessible. They are your lifeline if you can’t access your primary 2FA method.

By setting up and managing 2FA, you significantly enhance the security of your GitHub account, making it much harder for unauthorized users to gain access.

Exploring Your GitHub Profile

Your GitHub profile is like your personal brand on the platform. It’s where people can see your work, contributions, and interests. Let’s dive into how you can make the most out of it.

Customizing Your Profile

First things first, you want your profile to stand out. Edit your README file to add a personal touch. You can include images, links, and even badges. This is your space to showcase who you are and what you do.

Understanding Contribution Graphs

Your contribution graph is a visual representation of your activity on GitHub. It shows your commits, pull requests, and other contributions. The more active you are, the greener your graph will be. This is a great way to show potential employers or collaborators your level of involvement.

Following Other Users

GitHub is a social platform, so don’t hesitate to follow other users. By following people, you can stay updated on their latest projects and contributions. It’s a great way to explore profiles and find inspiration for your own work.

Your GitHub profile is more than just a page; it’s a reflection of your journey and achievements in the coding world.

Installing Git on Your Computer

Getting Git up and running on your computer is the first step to start using GitHub effectively. Whether you’re on macOS or Windows, we’ve got you covered with simple steps to get Git installed and verified.

Installing Git on macOS

Open Terminal: You can find it in /Applications/Utilities/ or use Spotlight search to locate it.
Check for Git: Type git and press Enter. If Git isn’t installed, a prompt will appear asking if you want to install the command line developer tools. Click Install.
Agree to Terms: Follow the prompts to agree to the terms of service.
Complete Installation: Once the download finishes, the installer will close automatically, indicating that Git is now installed.

Installing Git on Windows

Download Git: Visit the official Git website and click on the downloads section to get the latest version for Windows.
Run the Installer: Follow the on-screen instructions to complete the installation.
Open Git Bash: After installation, open the Start menu, search for Git Bash, and open it.
Verify Installation: In Git Bash, type git --version to check if Git was installed correctly. You should see the version number displayed.

Verifying Your Git Installation

After installing Git, it’s crucial to verify that everything is set up correctly. Open your terminal or Git Bash and type git --version. If you see the version number, you’re all set!

Pro Tip: If you encounter any issues, make sure to check the official Git documentation for troubleshooting tips.

With Git installed, you’re now ready to start managing your projects and collaborating with others on GitHub!

Connecting Git to GitHub

Setting Up SSH Keys

To connect Git to GitHub using SSH, you’ll need to generate SSH keys on your computer. This ensures a secure connection between your local machine and GitHub. Follow these steps:

Generate a new SSH key: Open your terminal and type ssh-keygen -t rsa -b 4096 -C "your_email@example.com". This command creates a new SSH key using your email as a label.
Add the SSH key to the ssh-agent: Start the ssh-agent in the background with eval "$(ssh-agent -s)", then add your SSH key with ssh-add ~/.ssh/id_rsa.
Add the SSH key to your GitHub account: Copy the SSH key to your clipboard with pbcopy < ~/.ssh/id_rsa.pub (macOS) or clip < ~/.ssh/id_rsa.pub (Windows). Then, go to GitHub, navigate to Settings > SSH and GPG keys, and click New SSH key. Paste your key and save.

Using HTTPS for Authentication

If you prefer using HTTPS for connecting Git to GitHub, follow these steps:

Clone the repository: Use the command git clone https://github.com/username/repository.git to clone your repository.
Cache your GitHub credentials: To avoid entering your username and password every time, you can cache your credentials. Use git config --global credential.helper cache to enable this feature.
Generate a Personal Access Token: For added security, generate a personal access token on GitHub. Go to Settings > Developer settings > Personal access tokens, click Generate new token, and select the scopes you need. Use this token as your password when prompted.

Testing Your Connection

After setting up SSH or HTTPS, it’s important to test your connection to ensure everything is working correctly.

Test SSH connection: Type ssh -T git@github.com in your terminal. You should see a message like "Hi username! You’ve successfully authenticated."
Test HTTPS connection: Simply try to push or pull from your repository using git push or git pull. If everything is set up correctly, the commands should execute without errors.

Pro Tip: Always double-check your configurations if you encounter any issues. A small typo can cause big headaches!

Connecting Git to GitHub is a crucial step in your development workflow. Whether you choose SSH or HTTPS, make sure to follow the steps carefully to ensure a smooth setup.

Creating Your First Repository

Creating your first GitHub repository is a significant milestone. It’s where your project will live and grow. Let’s walk through the steps to get you started.

Initializing a Repository Locally

Open your terminal and navigate to the directory where you want to create your project.
Run mkdir my_first_repo to create a new directory.
Change into the new directory with cd my_first_repo.
Initialize a new Git repository by running git init. This command sets up all the necessary files for Git to track changes.
Create a README file with echo "# My First Repository" >> README.md. This file is essential as it describes your project.
Add the README file to the staging area using git add README.md.
Commit your changes with git commit -m "Initial commit". Congratulations! You’ve made your first commit.

Pushing to GitHub

Go to your GitHub dashboard and click the New repository button.
Name your repository and add an optional description. For example, my_first_repo and "This is my first repository on GitHub."
Choose the repository’s visibility: Public or Private.
Click Create repository.

Follow the instructions to push your local repository to GitHub. Typically, you’ll run:

git remote add origin https://github.com/your_username/my_first_repo.git
git branch -M main
git push -u origin main

Refresh your GitHub page, and you should see your files online.

Cloning a Repository

On GitHub, navigate to the repository you want to clone.
Click the Code button and copy the URL.
Open your terminal and run git clone https://github.com/username/repo_name.git.
Change into the new directory with cd repo_name.
You’re all set to start working on the project locally.

Setting up your first GitHub repository is a crucial step in your coding journey. It allows you to back up your work and collaborate with others easily.

Understanding GitHub Workflows

Creating Branches

Creating branches in GitHub is a way to work on different parts of a project without affecting the main codebase. Think of a branch as a copy of your project where you can make changes and test new features. Once you’re happy with the changes, you can merge the branch back into the main codebase.

Navigate to your repository on GitHub.
Click on the Branch dropdown menu.
Type a name for your new branch and press Enter.

Making Commits

Commits are snapshots of your project at a specific point in time. They allow you to track changes and revert to previous versions if needed. Each commit should have a clear and concise message describing what changes were made.

Stage your changes: Add the files you want to commit.
Write a commit message: Describe what you’ve done.
Commit the changes: Save the snapshot.

Opening Pull Requests

Pull requests are a way to propose changes to a project. They allow you to review and discuss changes before they are merged into the main codebase. This is especially useful for collaborative projects.

Navigate to the Pull Requests tab in your repository.
Click on New Pull Request.
Select the branch you want to merge and the branch you want to merge into.
Add a title and description for your pull request.
Click Create Pull Request.

Pull requests are essential for maintaining code quality and fostering collaboration. They allow team members to review each other’s work and catch potential issues early.

Understanding these basic workflows will help you manage your projects more effectively and collaborate with others seamlessly.

Collaborating on GitHub

Inviting Collaborators

To get started with collaboration, you need to invite others to your repository. In your repository page on GitHub, click the “Settings” button on the right, select “Collaborators”, click “Add people”, and then enter your partner’s username. This way, you can easily add team members and start working together.

Reviewing Pull Requests

Pull requests are a great way to review code changes. When someone submits a pull request, you can review the changes, leave comments, and even request further modifications. This process ensures that all code is thoroughly checked before being merged into the main branch.

Managing Issues

Issues are used to track tasks, enhancements, and bugs for your projects. You can assign issues to team members, add labels for better organization, and even link issues to pull requests. This helps in keeping the project organized and ensures that everyone is on the same page.

Effective collaboration on GitHub involves clear communication and proper management of tasks and code reviews. By using these tools, you can ensure a smooth workflow and successful project outcomes.

Exploring GitHub Integrations

Using GitHub Actions

GitHub Actions lets you automate tasks right in your repository. You can set up workflows to build, test, and deploy your code. It’s a game-changer for continuous integration and continuous deployment (CI/CD). With GitHub Actions, you can:

Automate your software workflows
Trigger actions based on events
Use pre-built actions from the marketplace

Integrating with Third-Party Tools

Integrations are tools that extend GitHub’s functionality. You can connect GitHub with various third-party tools to enhance your development process. For example, you can integrate with project management tools, CI/CD services, and more. This makes it easier to manage your projects and collaborate with your team.

The GitHub integration enables you to manage your Adobe Commerce on cloud infrastructure environments directly from your GitHub repository.

Exploring GitHub Marketplace

The GitHub Marketplace is your one-stop shop for finding tools and applications that integrate with GitHub. From code quality tools to project management solutions, the marketplace has it all. By integrating GitHub with Common Room, you can see contributors, comments, pull requests, repo stars, repo forks, issues, discussions, and top programming languages. This helps you streamline your workflow and improve productivity.

Securing Your GitHub Account

Setting Up Security Policies

To keep your repositories safe, you need to set up security policies. Under the repository name, click Security. If you can’t see the "Security" tab, select the dropdown menu, and then click Security. This will help you manage access and ensure your code is protected.

Managing Access Controls

You can manage security settings and review the audit log and integrations for your organization. This is crucial for keeping track of who has access to what and ensuring that only authorized users can make changes.

Monitoring Security Alerts

With InstaSafe, enterprises can now provide users with secure access to GitHub using InstaSafe Single Sign-On (SSO) and Multi-Factor Authentication (MFA). This adds an extra layer of security to your account, making it harder for unauthorized users to gain access.

Always keep an eye on your security alerts to quickly address any potential threats.

You can securely access your account’s resources by authenticating to GitHub Enterprise Server, using different credentials depending on where you authenticate. This ensures that your data remains safe and only accessible to those who have the right permissions.

In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings. This will allow you to manage advanced security features and keep your account secure.

Participating in the GitHub Community

Joining GitHub Discussions

Engaging in GitHub Discussions is a great way to connect with other developers. To start, go to the repository settings. Under the "features" section, check the box to enable discussions. Then, head over to the “Discussions” tab in your repository to start or join a conversation. It’s a fantastic way to share knowledge and get help.

Contributing to Open Source

Contributing to open source projects can be incredibly rewarding. Look for projects that interest you. You can use GitHub’s search and filter by topics you’re passionate about, like Python, web development, or data science. Once you find a project, fork the repository, make your changes, and submit a pull request. This is a great way to learn and give back to the community.

Following GitHub Community Guidelines

Participate in community discussions, help other users, submit bug reports, comment on issues, try out new releases, and attend community events. Following these guidelines ensures a positive experience for everyone involved. Always be respectful and considerate in your interactions.

Supporting Open Source with GitHub Sponsors

GitHub Sponsors allows you to support developers and organizations who create and maintain open source projects. Launch a page in minutes and showcase sponsor buttons on your GitHub profile and repositories. This is a great way to give back to the community and support the projects you rely on.

Learning How to Contribute

If you’re new to contributing to open source, don’t worry! There are plenty of resources available to help you get started. Learn how to find, fork, and submit pull requests with comprehensive guides available on GitHub. It’s easier than you think, and you’ll be making valuable contributions in no time.

Joining the GitHub community is a great way to learn, share, and grow as a developer. Whether you’re contributing to open-source projects or collaborating with others, there’s always something new to discover. Want to dive deeper? Check out our website for more tips and resources!

Conclusion

Setting up your GitHub account and getting started with its features might seem like a lot at first, but it’s a rewarding process. By following this guide, you’ve learned how to create an account, set up Git, and start collaborating on projects. With GitHub, you can manage your code, work with others, and contribute to the open-source community. Keep exploring and practicing, and soon you’ll be a GitHub pro. Happy coding!