diff --git a/Projects/2-Intermediate/CodeMate-Ai.md b/Projects/2-Intermediate/CodeMate-Ai.md new file mode 100644 index 000000000..b7d4c2098 --- /dev/null +++ b/Projects/2-Intermediate/CodeMate-Ai.md @@ -0,0 +1,74 @@ +# ๐Ÿง  CodeMate AI โ€” Your Code Explanation Assistant + +**CodeMate AI** is an intelligent web application that explains any piece of code in clear, human-understandable language. +It helps developers, students, and learners quickly grasp complex code logic using AI-powered explanations. + +--- + +## ๐Ÿš€ Features + +- ๐Ÿ” **AI Code Explanation:** Paste any code snippet and get a detailed, natural-language explanation. +- โšก **Real-Time Response:** Fast and accurate understanding powered by an integrated AI API. +- ๐Ÿ–ฅ๏ธ **Modern UI:** Responsive, minimal interface built with React (Vite) and Tailwind CSS. +- ๐ŸŒ **Cross-Platform:** Works seamlessly on desktop and mobile browsers. +- ๐Ÿ”’ **Secure Backend:** Node.js + Express server with safe API routing and data handling. + +--- + +## ๐Ÿงฉ Tech Stack + +### Frontend +- React (Vite) +- Tailwind CSS +- Hosted on **Netlify** + +### Backend +- Node.js + Express +- Integrated with an AI API for code interpretation +- Hosted on **Render** + +### Package Manager +- Yarn + +--- + +## ๐Ÿ’ก Live Demo + +๐Ÿ”— [Try CodeMate AI](https://codemate-ai-frontend.netlify.app) + +--- + +## ๐Ÿง  How It Works + +1. User pastes code into the input area. +2. Frontend sends it to the backend API. +3. The backend calls an AI model endpoint. +4. AI returns an explanation โ†’ displayed neatly on the frontend. + +--- + +## ๐Ÿงช Run Locally + +### Clone the repository +```bash +git clone https://github.com//codemate-ai.git +cd codemate-ai + +yarn install + +cd frontend +yarn dev + +cd ../backend +yarn dev +``` + +### ๐Ÿ‘จโ€๐Ÿ’ป Author +Aswanth KT +MERN Stack Developer | AI & Web Enthusiast + +๐ŸŒ [Portfolio](https://aswanthkt-portfolio.vercel.app/) + +๐Ÿ’ผ [LinkedIn](https://www.linkedin.com/in/aswanth-kt/) + +๐Ÿ™ [GitHub](https://github.com/aswanth-kt)