User Stats

GitHub Achievements Finder 🎖️

GitHub Achievements Finder is a web application that allows users to search for a GitHub username and view their profile details, repositories, and achievements. It's an engaging tool to explore a developer's journey on GitHub!

---

🚀 Features

• Search for any GitHub user.
• View profile details such as followers, repositories, and public gists.
• Display GitHub achievements as interactive badges.
• Responsive design for a seamless user experience across devices.
• Animated loaders for better UX during data fetching.

---

📂 File Structure

The project is organized as follows:

user-stats/
├── client/
│ ├── public/
│ │   ├── index.html
│ ├── src/
│ │   ├── components/
│ │   │   ├── Commits.jsx
│ │   │   ├── Footer.jsx
│ │   │   ├── Logger.jsx
│ │   │   ├── Pagination.jsx
│ │   │   ├── Repositories.jsx
│ │   │   ├── SearchBar.jsx
│ │   │   ├── UserDetails.jsx
│ │   │   ├── Stats.jsx
│ │   ├── utils/
│ │   │   ├── githubApi.js
│ │   │   ├── twitterApi.js
│ │   ├── App.js
│ │   ├── index.css
│ │   ├── index.js
│ ├── tailwind.config.js
│ ├── package.json

---

🛠️ Installation

Follow these steps to set up the project locally:

1. Clone the repository:

   git clone https://github.com/Gyanthakur/User-Stats.git
   cd User-Stats
   cd client

2. Install dependencies::

   npm install

3. Run the application::

   npm run dev

4. Open in browser: The app will be available at http://localhost:3000.

---

📸 Screenshots

• Search Page

• Profile

  

• Commits

  

• Achievements Display

  

• Mobile view

---

🔍 Usage

• Enter a GitHub username in the search bar.
• Click Search to fetch the user's data.
• View the user's profile details, repositories, and achievements.

🧩 Technologies Used

• Frontend: React.js, Tailwind CSS
• APIs: GitHub REST API
• Icons: Phosphor Icons

🐛 Known Issues

• API Rate Limiting: GitHub's API has rate limits. Use a personal access token if you exceed the limit.
• Achievements Data: Some achievements may not be available for certain accounts.

🌟 Acknowledgments

• GitHub REST API for making this project possible.
• Tailwind CSS for streamlined styling.
• Phosphor Icons for beautiful and accessible icons.

🛠️ Future Enhancements

• Add dark mode support.

• Cache API responses for better performance.

• Integrate more GitHub features like pinned repositories.

  ---

🔐 License

This project is licensed under the MIT License.

---

✨ Made with ❤️ by Gyan Pratap Singh ✨

🌐 Connect with Us

Contact Us: 📲

• Name: Gyan Pratap Singh
• Email: gps.96169@gmail.com
• GitHub: Gyanthakur
• Portfolio: Gyan's Portfolio

---

Thank you for checking out the User Stats project! Happy coding! 😊