Hugging Face's logo

Spaces:
Hma47
/
Code-Explainer
Running

App Files Community
Code-Explainer
File size: 3,482 Bytes 
a0cfa52
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
---

title: "🧠 CodeTutor Pro – Intelligent Code Explanation Platform"
emoji: "💡"
colorFrom: "blue"
colorTo: "purple"
sdk: "static"
sdk_version: "0.1.0"
app_file: "index.html"
pinned: false
---


# 🧠 CodeTutor Pro – Intelligent Code Explanation Platform  
**Developed by Shift Mind AI Labs**

CodeTutor Pro is an open-source, privacy-first platform that transforms code into clear, beginner-friendly, and multi-language explanations—instantly powered by AI. Whether you are a student, teacher, or developer, this tool helps demystify code, deepen understanding, and accelerate your programming learning journey.

---

## 🚀 Features

- **Plain-Language Explanations:** Converts complex code into easy, jargon-free text.
- **Line-by-Line & Conceptual Analysis:** Detailed, sectioned explanations (no code snippets) with stepwise logic and key concepts.
- **Multi-Level Output:** Choose from “Complete Beginner” to “Advanced” for the right depth.
- **Supports All Languages:** Works with Python, Java, C++, JS, HTML, SQL, and more.
- **Full Multilingual UI:** 90+ languages, RTL/LTR support, instant translation (OpenAI API required).
- **Editable Explanations:** Output is content-editable for class notes, customization, or portfolio building.
- **Privacy-First:** API key and all data stored locally; never leaves your device.

---

## 🛠 How to Use

1. **Open the tool** in your browser or on Hugging Face Spaces (no install/login).
2. **Select your interface language** (auto-translate supported).
3. **Enter your OpenAI API key** (kept private in your browser).
4. **Paste or type your code** (any language; up to 1 million characters).
5. *(Optional)* Select your programming language and explanation level.
6. **Click “🧠 Generate Explanation”.**
7. **Read, edit, and copy** your customized, sectioned explanation for class, homework, or sharing.
8. **Switch languages or clear cache** anytime for updated UI and output.

---

## 👩‍🏫 For Educators: Classroom Applications

- **Instant Code Explanation:** Great for assignments, flipped learning, and project walkthroughs.
- **Student Differentiation:** Match output depth to learner level; use in ELL/multilingual classes.
- **Editable Output:** Use in LMS, printouts, or digital portfolios.
- **PD & Training:** Onboard new teachers to unfamiliar codebases or languages.

---

## 👨‍🎓 For Students: Benefits

- **Learn Any Code:** Instantly understand code in your preferred language and depth.
- **Practice Reflection:** Edit and personalize explanations for deeper learning.
- **Safe Exploration:** No accounts or data sharing—perfect for minors and privacy-sensitive contexts.

---

## 🔐 Data Privacy

- Your OpenAI API key, code, and all data are stored only on your device.
- Nothing is transmitted to Shift Mind AI Labs, Hugging Face, or third parties.

---

## 📄 License

Licensed under the [Apache License 2.0](./LICENSE).

---

## 🧠 About Shift Mind AI Labs

Shift Mind AI Labs builds open-source, ethical AI tools for global education, digital skills, and lifelong learning.

🌐 https://www.shiftmind.io  
✉️ info@shiftmind.io

---

## 🙌 Contributing

Feedback, pull requests, and pilots welcome!  
For partnerships, research, or school programs: **info@shiftmind.io**

---

*Bringing expert code explanations to every learner, everywhere, in every language.*