GitHub Repo Inspector 🚀

GitHub Repo Inspector is a GitHub-integrated developer tool that analyzes GitHub profiles and repositories to evaluate repository health, documentation quality, license usage, and activity metrics using the GitHub REST API and OAuth.

This project is built as a real-world developer utility and portfolio project, following proper backend–frontend separation and security best practices.

---

🔍 What Problem Does It Solve?

Recruiters and developers often struggle to quickly understand:

• How active a GitHub profile is
• Whether repositories follow open-source best practices
• Which repositories are well-maintained

GitHub Repo Inspector provides a clear health score, repo-wise insights, and visual analytics to solve this problem.

---

✨ Features

🔐 GitHub OAuth Authentication

• Secure login using GitHub OAuth
• No passwords stored
• Uses GitHub’s official authentication flow

👤 Profile Analysis

• Total repositories count
• Repositories with README
• Active repositories (recent commits)
• Average repository health score
• Repositories ranked by score (high → low)
• Pagination for large profiles

📦 Repository Analysis

• README detection
• License check
• Recent commit activity
• Health score (0–100)
• Tech stack detection (via GitHub Languages API)

📊 Interactive Dashboard

• Visual charts for repository health comparison
• Click-to-analyze individual repositories
• Clean, recruiter-friendly UI

---

🧮 Health Score Logic

Each repository is scored out of 100 using transparent logic:

Check	Points
README present	+30
License present	+30
Recent commits (last 30 days)	+40
Total	100

---

🛠️ Tech Stack

Frontend

• React (Vite)
• Recharts
• Modern CSS

Backend

• Node.js
• Express.js
• GitHub REST API
• GitHub OAuth 2.0

Security

• Environment variables for secrets
• .env excluded using .gitignore
• OAuth handled securely on the server

---

🏗️ Project Structure

github-repo-inspector/ │ ├── backend/ │ ├── index.js │ ├── package.json │ └── .gitignore │ ├── frontend/ │ ├── src/ │ │ ├── App.jsx │ │ ├── App.css │ │ └── main.jsx │ ├── index.html │ └── package.json │ └── README.md

---

⚙️ Local Development Setup

1️⃣ Clone Repository

git clone https://github.com/AdarshCodes1221/github-repo-inspector
cd github-repo-inspector
2️⃣ Backend Setup
cd backend
npm install


Create a .env file:

GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret
GITHUB_PERSONAL_TOKEN=your_token
PORT=3000


Run backend:

node index.js

3️⃣ Frontend Setup
cd frontend
npm install
npm run dev

🔒 Security & Best Practices

No secrets committed to GitHub

OAuth tokens handled server-side

GitHub API calls authenticated securely

Follows principle of least privilege

🎯 Use Cases

Recruiters reviewing GitHub profiles

Developers auditing repository quality

Students showcasing GitHub API integration

Portfolio project demonstrating full-stack skills

🚀 Future Enhancements

AI-based repository improvement suggestions

GitHub Actions integration

Security vulnerability analysis

Export reports (PDF / CSV)

Organization-level analysis

👤 Author

Adarsh Jha
Computer Science Student | Cloud & Security Enthusiast

GitHub: https://github.com/AdarshCodes1221

📄 License

This project is intended for educational and portfolio purposes.