Skip to content

ContribLens is an AI-powered tool for quick insights into GitHub repository contributions.

Notifications You must be signed in to change notification settings

rdfariz/ContribLens

Repository files navigation

GitHub Analyzer

AI-powered GitHub repository contribution analysis tool. Understand your team's productivity, code quality, and contributor performance at a glance.

GitHub Analyzer Vite License

Features

  • Repository Analysis - Analyze any public or private GitHub repository
  • Contribution Metrics - See commits, lines added/removed, and code changes per contributor
  • AI-Powered Insights - Get intelligent analysis of work styles, code quality, and team dynamics
  • Date & Contributor Filters - Filter analysis by date range or specific contributors
  • Multi-language Support - UI in English, reports in English or Indonesian
  • Share Results - Generate shareable links with encoded analysis data
  • Analysis History - Access your previous analyses from local storage
  • Responsive Design - Works on desktop, tablet, and mobile devices

Tech Stack

  • Frontend: Vue.js 3 (Composition API)
  • Build Tool: Vite 7
  • Animation: GSAP
  • HTTP Client: Axios
  • AI: OpenAI GPT API (optional)
  • Deployment: Vercel

Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • GitHub Personal Access Token (Create one here)
  • OpenAI API Key (optional, for AI features)

Installation

  1. Clone the repository:
git clone https://github.com/rdfariz/github-analyzer.git
cd github-analyzer
  1. Install dependencies:
npm install
  1. Create environment file (optional):
cp .env.example .env
  1. Configure environment variables:
# Enable/disable AI features globally
VITE_AI_ENABLED=true

# Default OpenAI API key (optional)
VITE_OPENAI_API_KEY=sk-your-api-key

# Allow users to enter custom API keys
VITE_ALLOW_CUSTOM_OPENAI_KEY=true
  1. Start development server:
npm run dev
  1. Open http://localhost:5173 in your browser

Building for Production

npm run build

The built files will be in the dist folder.

Deployment

Vercel (Recommended)

  1. Push your code to GitHub
  2. Import the project in Vercel
  3. Configure environment variables in Vercel dashboard
  4. Deploy!

The vercel.json is already configured with:

  • SPA routing support
  • Security headers
  • Asset caching
  • Vite framework detection

Manual Deployment

Build the project and deploy the dist folder to any static hosting service (Netlify, GitHub Pages, etc.)

Environment Variables

Variable Description Default
VITE_AI_ENABLED Enable AI-powered analysis false
VITE_OPENAI_API_KEY Default OpenAI API key -
VITE_ALLOW_CUSTOM_OPENAI_KEY Allow users to enter their own API key false

Usage

  1. Connect Repository

    • Enter your GitHub Personal Access Token
    • Paste the repository URL (supports HTTPS, SSH, or owner/repo format)
  2. Select Branch

    • Choose the branch to analyze
    • Optionally filter by date range or specific contributors
    • Configure AI settings if available
  3. View Results

    • Overview tab: Top contributor stats and contribution breakdown
    • AI Insights tab: Team dynamics, code quality scores, and recommendations
    • All Contributors tab: Detailed list of all contributors
  4. Share or Export

    • Click "Share" to generate a shareable link
    • Analysis is saved to history for future reference

Security

  • GitHub tokens are stored locally in browser (optional)
  • Tokens are never sent to any third-party servers
  • All API calls are made directly to GitHub/OpenAI
  • Security headers configured for production deployment

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 file for details.

Author

rdfariz - GitHub


Made with ❤️ by rdfariz

About

ContribLens is an AI-powered tool for quick insights into GitHub repository contributions.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published