Skip to content

MikkyPrestige/git-audit

Repository files navigation

GitAudit

A simple, professional tool to audit and compare GitHub repositories. This app helps you understand how a project is built and lets you see how it stacks up against others.


What it does

  • Single Audit: Paste a GitHub link to get a deep-dive scan of the project's structure and quality.
  • Comparison Mode: Put two repositories side-by-side to see the differences in their metrics.
  • Visual Reports: Uses clear charts and scores so you don't have to dig through raw data.
  • Live Progress: A step-by-step loading bar shows exactly what the app is analyzing in real-time.

How to Use

  1. Enter a URL: Drop any GitHub repository link into the search bar.
  2. Start the Scan: Click the audit button to trigger the forensic analysis.
  3. Check the Results: View the breakdown of the code and its performance.
  4. Compare: Switch to "Compare Mode" to analyze two projects at the same time.

Installation

If you want to run this project locally, follow these steps:

  1. Clone the project

    git clone [https://github.com/MikkyPrestige/GitAudit.git](https://github.com/MikkyPrestige/GitAudit.git)
    cd GitAudit
  2. Install dependencies

    npm install
  3. Run the application

    npm run dev

Technical Details

  • Frontend: Built with React and TypeScript.
  • Styling: Clean, modern UI using Tailwind CSS.
  • Icons: Simple and clear visuals using Lucide React.

Author

MikkyPrestige (Elue Michael)

About

Analyze and compare GitHub projects side-by-side to understand code structure, quality and metrics.

Topics

Resources

Stars

Watchers

Forks

Contributors