Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 2.59 KB

README.md

File metadata and controls

93 lines (64 loc) · 2.59 KB
Raw

GitHub Buddy Finder

🌟 Live Demo

Find your perfect coding companion with GitHub Buddy Finder! This innovative web application helps developers connect with like-minded individuals based on their GitHub activity and language preferences.

🚀 Features

  • 🔍 Smart Search: Find potential coding buddies using just a GitHub username
  • 🧠 Intelligent Matching: Our algorithm suggests buddies based on coding habits and interests
  • 📊 Skill Visualization: See language preferences and coding activity patterns at a glance
  • 🌓 Dark Mode: Toggle between light and dark themes for comfortable viewing
  • 🔄 Efficient API Usage: Implements token rotation to handle GitHub API rate limits

🛠️ Technologies Used

  • React
  • Vite
  • GitHub API
  • Octokit
  • Chart.js (for data visualization)
  • CSS3 for styling

📋 Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js (v14.0.0 or later)
  • npm (v6.0.0 or later)
  • GitHub Personal Access Tokens (at least 3 for API access)

🔧 Installation & Setup

  1. Clone the repository:

    git clone https://github.com/your-username/github-buddy-finder.git

  2. Navigate to the project directory:

    cd github-buddy-finder

  3. Install dependencies:

    npm install

  4. Create a .env file in the root directory and add your GitHub tokens:

    VITE_GITHUB_TOKEN_1=your_first_token_here
VITE_GITHUB_TOKEN_2=your_second_token_here
VITE_GITHUB_TOKEN_3=your_third_token_here

  5. Start the development server:

    npm run dev

  6. Open http://localhost:3000 in your browser to see the app running.

🖥️ Usage

  1. Enter a GitHub username in the search bar.
  2. View the user's profile, language statistics, and recent activity.
  3. Explore suggested coding buddies based on compatibility.
  4. Connect with potential buddies or view their GitHub profiles.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.

📄 License

This project is MIT licensed.

👤 Author

Your Name

🙏 Acknowledgements

⭐️ If you like this project, please give it a star on GitHub! ⭐️