Skip to content

README.md

Latest commit

 

History

History
87 lines (54 loc) · 2.24 KB

README.md

File metadata and controls

87 lines (54 loc) · 2.24 KB

🔍 AI Code Review Assistant

Get instant, senior-level code feedback powered by Google Gemini

Paste your code → Get 3 improvements, 1 positive note, and an optional refactored snippet

Python Streamlit Gemini

✨ What it does

AI Code Review Assistant uses Google's Gemini API to review your code like a senior software engineer. For any snippet you paste, you get:

Output Description
3 Improvements Actionable suggestions for readability, structure, and maintainability
1 Positive Note What you did well—no nitpicking without recognition
Refactored Example Optional improved code when meaningful changes can be suggested

📸 Screenshots

Input — Paste your code and hit Review

App interface with code input

Output — Improvements, positive feedback, and refactored code

Full code review with improvements

Positive note and refactored example

🚀 Quick Start

1. Clone & setup

git clone git@github.com:khubaib-ctrl/ai-code-assistant.git
cd ai-code-assistant

python -m venv venv
source venv/bin/activate   # Windows: venv\Scripts\activate

pip install -r requirements.txt

2. Get a Gemini API key

  • Go to Google AI Studio
  • Create an API key (free tier available)
  • Enter it in the app, or set GOOGLE_API_KEY in your environment

3. Run the app

streamlit run app.py

Paste your code, enter your API key, and click Review Code.

📁 Project Structure

ai-code-assistant/
├── app.py           # Single-file app (UI, prompt, Gemini integration)
├── requirements.txt
├── README.md
└── image *.png      # Screenshots

📄 License

MIT