/Githubstreak-frontend

A way for developers to stay consistent in their coding journey.

Primary LanguageJavaScriptMIT LicenseMIT

GitHubStreak

GitHubStreak is an open-source project that aims to rank developers based on their contributions to GitHub repositories and the number of consecutive days they have committed code (known as a "streak"). This project serves as a valuable tool for developers to showcase their commitment and activity on GitHub, and for potential employers or collaborators to identify dedicated and productive contributors.

Features

  • Contribution Ranking: Developers are ranked based on the number of contributions (commits, pull requests, issues, etc.) they have made to GitHub repositories.
  • Streak Tracking: The application tracks and displays the longest streak of consecutive days a developer has committed code to a repository.
  • Leaderboard: A leaderboard showcases the top-ranked developers based on their contributions and streaks.
  • User Profiles: Detailed profiles for each developer, displaying their contributions, streak history, and other relevant information.
  • GitHub Integration: GitHubStreak seamlessly integrates with the GitHub API to fetch and analyze developer data.

Installation

  1. Clone the repository: git clone (https://github.com/Githubstreak/Githubstreak-frontend.git)
  2. Navigate to the project directory cd
  3. Install dependencies: npm install
  4. Set up environment variables (see .env.example file)
  5. Start the development server: npm start

Usage

  1. Visit the GitHubStreak website or application. https://githubstreak-frontend.vercel.app/
  2. Connect your GitHub account to grant access to your contribution data.
  3. View the leaderboard to see the top-ranked developers based on contributions and streaks.
  4. Explore individual developer profiles for detailed information.

Contributing

We welcome contributions from developers of all skill levels! Please follow our contributing.md to get started.

Code of Conduct

We aim to foster an open and welcoming community. Please review our Code of Conduct to understand the expectations for participation in this project.

License

This project is licensed under the MIT License.

Acknowledgments

GitHubStreak was inspired by the need to recognize and celebrate the hard work and dedication of developers. We would like to thank all the contributors who have made this project possible.