https://github.com/codervivek5/gitinsights
https://github.com/codervivek5/gitinsights
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/codervivek5/gitinsights
- Owner: codervivek5
- Created: 2025-04-12T18:53:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-12T19:56:14.000Z (about 1 year ago)
- Last Synced: 2025-04-12T20:19:06.740Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://git-insights.vercel.app
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitInsights 📊
A modern, elegant GitHub repository analytics tool that provides detailed insights and visualizations for public GitHub repositories.
#Preview
## ⚠️ Important Note
**This tool only works with public repositories. Private repositories cannot be accessed due to GitHub API restrictions.**
## 🚀 Features
- **Repository Overview**
- Stars, Forks, Issues, and Pull Requests count
- Beautiful, animated UI with glassmorphism effects
- Real-time data fetching from GitHub API
- **Contributor Analysis**
- Top contributors visualization
- Contribution statistics
- Direct links to contributor profiles
- **Code Analytics**
- Language distribution with percentage breakdown
- Interactive progress bars
- Comprehensive code statistics
- **Pull Request Insights**
- Open vs. Closed PR comparison
- PR status visualization
- Trend analysis
- **Commit History**
- Recent commits timeline
- Author information
- Commit message previews
- Timestamp tracking
- **Export Capabilities**
- Export reports as PNG
- Export reports as PDF
- High-quality report generation
## 🛠️ Tech Stack
- React.js
- Material-UI
- Framer Motion
- GitHub REST API
- html2canvas
- jsPDF
## 🚦 Getting Started
1. Clone the repository:
```bash
git clone https://github.com/codervivek5/GitInsights.git
```
2. Install dependencies:
```bash
cd GitInsights
npm install
```
3. Start the development server:
```bash
npm run dev
```
4. Open your browser and navigate to `http://localhost:5173`
## 🎯 How to Use
1. Enter a GitHub repository URL or username/repository format
2. Click 'Generate Report' to view insights
3. Explore different sections of the analytics dashboard
4. Export reports in your preferred format (PNG/PDF)
## ⚡ Performance
- Optimized for quick loading
- Efficient data fetching
- Smooth animations
- Responsive design for all devices
## 🔒 Privacy Note
This tool only works with **public repositories**. It cannot access:
- Private repositories
- Private user data
- Organization-specific private data
- Rate-limited API endpoints
## 🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- GitHub API for providing the data
- Material-UI for the component library
- Framer Motion for animations
- All contributors who help improve this project
---
Made with ❤️ by [Vivek Kumar](https://github.com/codervivek5)