https://github.com/gyanthakur/user-stats
🎖️🎖️🎖️ 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!
https://github.com/gyanthakur/user-stats
github githubapi githubapiwrapper phosphor-react react tailwindcss vite
Last synced: about 1 month ago
JSON representation
🎖️🎖️🎖️ 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!
- Host: GitHub
- URL: https://github.com/gyanthakur/user-stats
- Owner: Gyanthakur
- Created: 2025-01-01T14:26:03.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-11T17:51:57.000Z (5 months ago)
- Last Synced: 2025-03-29T18:11:50.186Z (2 months ago)
- Topics: github, githubapi, githubapiwrapper, phosphor-react, react, tailwindcss, vite
- Language: JavaScript
- Homepage: https://user-stats-zeta.vercel.app
- Size: 174 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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**:
```bash
git clone https://github.com/Gyanthakur/User-Stats.git
cd User-Stats
cd client
```
2. **Install dependencies:**:
```bash
npm install
```
3. **Run the application:**:
```bash
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](LICENSE).
---
## ✨ Made with ❤️ by Gyan Pratap Singh ✨
## 🌐 Connect with Us
Contact Us: 📲
- **Name**: Gyan Pratap Singh
- **Email**: [[email protected]](mailto:[email protected])
- **GitHub**: [Gyanthakur](https://github.com/Gyanthakur)
- **Portfolio**: [Gyan's Portfolio](https://gyan-pratap-singh.vercel.app/)
---
## Thank you for checking out the User Stats project! Happy coding! 😊
