Skip to content

README.md

Latest commit

 

History

History
125 lines (88 loc) · 2.96 KB

README.md

File metadata and controls

125 lines (88 loc) · 2.96 KB

GitInsights Pro

📖 README | 💡 IDEATION | 📊 ER Diagram

GitHub Analytics Dashboard for developer productivity insights.

🛠️ Tech Stack

Frontend: React 18 • Vite 5 • Tailwind CSS • Hero UI • Recharts • React Router
Backend: Node.js 18+ • Express 4 • Prisma 5 • MySQL
External: GitHub API • GitHub OAuth

🚀 Quick Start

# Backend
cd backend
npm install
npm run dev

# Frontend
cd frontend
npm install
npm run dev

Frontend: http://localhost:5173
Backend: http://localhost:3000

Environment Setup

backend/.env

DATABASE_URL="mysql://user:password@localhost:3306/gitinsights"
GITHUB_CLIENT_ID=your_client_id
GITHUB_CLIENT_SECRET=your_client_secret
JWT_SECRET=your_jwt_secret
SESSION_SECRET=your_session_secret
PORT=3000

frontend/.env

VITE_API_URL=http://localhost:3000

📊 Progress

✅ Week 1: Foundation & MVP

Setup & Infrastructure ✓

  • Monorepo structure — TechGenie-awake
  • Backend setup (Node + Express + Prisma + MySQL) — TechGenie-awake
  • Frontend setup (React + Vite + Tailwind) — [Name]
  • Git workflow & environment config — [Name]

Core Features

  • Landing page — Mridul012
  • Complete folder structure — krishx06
  • Database schema — TechGenie-awake
  • Express API (languages, contributors, commits, stats) — Lex-Ashu

Authentication 🔄

  • GitHub OAuth SignIn UI — krishx06
  • OAuth app configuration — krishx06
  • Complete auth endpoints (/auth/login, /auth/callback, /auth/me) — krishx06
  • Protected routes & JWT management — krishx06
  • User profile component — [Name]

First Chart 📊

  • /api/repos & /api/repos/:id/commits endpoints — [Name]
  • Repository selector dropdown — [Name]
  • Commit timeline chart (Recharts) — [Name]
  • Loading states & error handling — [Name]
  • Date range filter (7d, 30d, 90d, all) — [Name]

🎯 Week 2: Core Analytics (Next)

Multiple Visualizations

  • Language distribution pie chart
  • Contributor bar chart
  • Activity heatmap
  • Statistics cards
  • File change analysis

Repository Management

  • Bulk sync endpoint
  • Search/filter repositories
  • Favorite repositories
  • Multi-repo comparison
  • Chart export (PNG/CSV)

Polish

  • Bug fixes & UI improvements
  • Performance optimization
  • Responsive design

Deliverable: Dashboard with 5+ chart types

👥 Contributors

  • TechGenie-awake — Backend infrastructure, database schema
  • Mridul012 — Landing page
  • krishx06 — Folder structure, OAuth integration
  • Lex-Ashu — API development

📝 Recent Activity

  • ✅ Merged login UI feature (PR #4)
  • ✅ GitHub OAuth SignIn added
  • ✅ Express API endpoints created
  • ✅ Folder structure completed

Latest Commits: Oct 29-30, 2025