Skip to content

Latest commit

 

History

40 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

πŸ“˜ CodeUnboxed – AI-Powered Code Explanation Tool

Live Demo: 🌐 https://codeunboxed.web.app
GitHub Repo: πŸ”— https://github.com/ARAVIND281/CodeUnboxed


πŸš€ Badges

React Tailwind CSS ShadCN UI FastAPI Python Groq AI License


✨ What is CodeUnboxed?

CodeUnboxed is an AI-powered code explanation tool built for developers, students, and educators. Just paste your code snippet, select a language and level, and get a clean, markdown-formatted explanation powered by Groq’s LLaMA 3 models.

Perfect for:

  • Students learning programming
  • Developers reviewing unfamiliar code
  • Interviews, walkthroughs, and code documentation

🧠 Features

  • 🧾 Paste code in 15+ languages
  • 🧠 AI-powered explanation using Groq LLMs
  • πŸ§ͺ Switch between Basic and Advanced modes
  • πŸ“„ Clean, markdown-styled output
  • πŸ–₯️ Responsive UI with Tailwind and ShadCN
  • πŸ’‘ React + FastAPI architecture

πŸ“ File Structure

CodeUnboxed/
β”‚
β”œβ”€β”€ backend/                  # FastAPI server
β”‚   β”œβ”€β”€ app/
β”‚   β”‚   β”œβ”€β”€ api.py
β”‚   β”‚   β”œβ”€β”€ groq_client.py
β”‚   β”‚   └── models.py
β”‚   β”œβ”€β”€ main.py
β”‚   β”œβ”€β”€ start.py
β”‚   β”œβ”€β”€ requirements.txt
β”‚   └── .env
β”‚
β”œβ”€β”€ codeunboxed-frontend/    # React + Vite frontend
β”‚   β”œβ”€β”€ src/
β”‚   οΏ½οΏ½   β”œβ”€β”€ components/
β”‚   β”‚   β”‚   └── CodeExplainer.tsx
β”‚   β”‚   └── App.tsx
β”‚   β”œβ”€β”€ index.html
β”‚   β”œβ”€β”€ main.tsx
β”‚   β”œβ”€β”€ tailwind.config.js
β”‚   └── .env
β”‚
β”œβ”€β”€ example/                 # Screenshots and demo
β”‚   β”œβ”€β”€ screenshot-input.png
β”‚   β”œβ”€β”€ screenshot-output.png
β”‚   └── demo.mp4
β”‚
└── README.md

πŸ–ΌοΈ Screenshots

🧾 Input Interface

Input Screenshot

πŸ€– Output Explanation

Output Screenshot



πŸ§‘β€πŸ’» Tech Stack

Frontend Backend AI Engine
React + Vite FastAPI (Python) Groq (LLaMA 3)
Tailwind + ShadCN Uvicorn + CORS dotenv for secrets
React Markdown RESTful APIs Firebase Hosting

βš™οΈ Getting Started (Local Dev)

1️⃣ Clone the repo

git clone https://github.com/ARAVIND281/CodeUnboxed
cd CodeUnboxed

2️⃣ Run the Backend

cd backend
pip install -r requirements.txt
python start.py

βœ… Create a .env file with your GROQ_API_KEY.

3️⃣ Run the Frontend

cd codeunboxed-frontend
npm install
npm run dev

Then open: http://localhost:5173


πŸ“¬ Author & Contact

Made by Aravind S
πŸ”— LinkedIn
πŸ’» GitHub


⭐️ Show Your Support

If you liked the project, consider giving it a ⭐️ on GitHub to support my work and help others discover it!

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages