Skip to content

Atnatewoss/GetGit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GetGit

GetGit is a powerful and intuitive web application that allows users to view detailed GitHub statistics for themselves and their friends. Whether you're tracking your coding journey or just having fun comparing stats, GetGit makes it easy to explore and share insights about GitHub activity.

Features

  • View GitHub Stats: Effortlessly access GitHub analytics for any user.
  • Compare with Friends: Share the platform with your friends and compare GitHub stats for a fun and engaging experience.
  • User-Friendly Interface: Designed to be intuitive, responsive, and accessible for all users.
  • GitHub Username Validation: Validate whether a GitHub username exists and retrieve related data using the GitHub API.

Why Use GetGit?

GetGit is perfect for:

  • Developers looking to track their progress over time.
  • Friends and colleagues interested in comparing GitHub activity.
  • Anyone who loves exploring GitHub data in a visually engaging and easy-to-understand way.

How It Works

GetGit connects to the GitHub API to retrieve data for a given GitHub username. By entering a username, users can view detailed statistics such as:

  • Repositories
  • Followers and following
  • Public activity data

Get Started

  1. Clone the repository or visit the GetGit website.
  2. Enter a GitHub username to view their stats.
  3. Share the platform with your friends to compare their GitHub activity too!

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Backend: Node.js, Express.js
  • API Integration: GitHub API for user stats
  • Environment Variables: Store sensitive data like GitHub tokens securely

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/yourusername/GetGit.git
  2. Navigate to the project folder:

    cd GetGit
  3. Install the required dependencies:

    npm install
  4. Create a .env file in the root directory and add your GitHub Token:

    GITHUB_TOKEN=your_github_token_here
    
  5. Start the application:

    npm start
  6. Open http://localhost:3000 in your browser to use GetGit locally.

Contributions

We welcome contributions! If you'd like to improve GetGit or suggest new features, feel free to submit an issue or a pull request. Here’s how you can contribute:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature-name)
  3. Commit your changes (git commit -am 'Add a new feature')
  4. Push to your branch (git push origin feature/your-feature-name)
  5. Create a new Pull Request

Feedback

Your feedback is valuable to us! Let us know how we can make GetGit even better by opening an issue or contacting us directly.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Explore GitHub profiles, browse repositories, and visualize avatars—all in one seamless interface.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published