Skip to content

dsetpal00/codebase-explainer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Contextual Codebase Explainer

Understand. Visualize. Optimize. This project is a powerful AI-driven tool designed to help developers navigate massive or unfamiliar codebases. It doesn't just explain code; it visualizes logic, monitors code health, and suggests modern refactors—all while keeping your project's specific documentation in context.


✨ Amazing features

1. 📊 Visual Logic Flow

Generates high-definition, color-coded Mermaid.js diagrams that map out function calls and logic paths. No more getting lost in spaghetti code!

2. 🩺 Code Vital Signs Monitor

An instant Code Health Score (0-100) paired with a "Brutal Verdict" from a virtual AI mentor. Know exactly how "clean" or "messy" your code is the moment you upload it.

3. 🚀 AI Smart Refactor (Transformer)

Identifies the most complex part of your code and provides a side-by-side, high-performance modernization suggestion.

4. 🧠 Context-Aware Analysis

Upload your company's Style Guide or Documentation along with the code. The AI ensures its explanations and suggestions follow your team's specific rules.

5. 🔄 Backward Compatibility Checker

Compare old versions of code with new ones to catch breaking changes before they hit production.


🛠️ Tech Stack

  • Backend: Python (Flask)
  • AI Engine: Google Gemini 2.5 Flash (Optimized for speed)
  • Frontend: HTML5, CSS3 (Modern Glassmorphism UI), JavaScript
  • Visualization: Mermaid.js

🚀 Quick Start

1. Prerequisites

  • Python 3.9+
  • A Google Gemini API Key

2. Installation

# Clone the repository
git clone [https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git](https://github.com/YOUR_USERNAME/YOUR_REPO_NAME.git)
cd YOUR_REPO_NAME

# Install dependencies
pip install flask google-generativeai

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors