Add CodeMate-Ai.md

pull/1085/head
aswanthkt31 6 months ago
parent 9e8dd00f10
commit 43f7fe80d3

@ -0,0 +1,81 @@
# 🧠 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/<your-username>/codemate-ai.git
cd codemate-ai
yarn install
cd frontend
yarn dev
cd ../backend
yarn start
---
👨‍💻 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]
Loading…
Cancel
Save