-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Add CodeMate-Ai.md #1085
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
aswanth-kt
wants to merge
3
commits into
florinpop17:master
Choose a base branch
from
aswanth-kt:code-mate-ai
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add CodeMate-Ai.md #1085
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
||
|
|
||
aswanth-kt marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| --- | ||
|
|
||
| 👨💻 Author | ||
|
|
||
| Aswanth KT | ||
| MERN Stack Developer | AI & Web Enthusiast | ||
|
|
||
| 🌐 Portfolio[https://aswanthkt-portfolio.vercel.app/] | ||
aswanth-kt marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 💼 LinkedIn[https://www.linkedin.com/in/aswanth-kt/] | ||
|
|
||
| 🐙 GitHub[https://github.com/aswanth-kt] | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.