Afeefa123 commited on
Commit
d499ad4
·
verified ·
1 Parent(s): 276925c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -9
README.md CHANGED
@@ -1,12 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: Smart Code Reviewer
3
- emoji: 🌖
4
- colorFrom: gray
5
- colorTo: purple
6
- sdk: gradio
7
- sdk_version: 6.9.0
8
- app_file: app.py
9
- pinned: false
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
1
+ # Smart Code Reviewer
2
+
3
+ An AI-powered tool that reviews code for readability, structure, maintainability, and best practices before human review.
4
+
5
+ This project demonstrates how large language models can assist developers by providing automated code analysis and suggestions.
6
+
7
+ ---
8
+
9
+ ## Features
10
+
11
+ - AI-based code review
12
+ - Code quality scoring
13
+ - Bug detection
14
+ - Refactoring suggestions
15
+ - Code explanation
16
+ - Multi-language support
17
+
18
  ---
19
+
20
+ ## Tech Stack
21
+
22
+ - Python
23
+ - Gradio
24
+ - Groq API
25
+ - Llama 3 Model
26
+ - Hugging Face Spaces
27
+
28
+ ---
29
+
30
+ ## How It Works
31
+
32
+ 1. User pastes code into the interface.
33
+ 2. The system sends the code to a large language model using the Groq API.
34
+ 3. The model analyzes the code and returns structured feedback including:
35
+
36
+ - Readability score
37
+ - Structure analysis
38
+ - Maintainability feedback
39
+ - Best practice suggestions
40
+ - Refactored code example
41
+
42
  ---
43
 
44
+ ## System Architecture