Skip to content

palguna26/AI-Code-Review-Commentator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

AI Code Commenter

A web application that allows users to upload code and receive automated comments and explanations using AI. The project consists of a frontend and backend.


Features

  • Upload code files directly from the browser.
  • AI-powered code analysis and commenting.
  • Clear separation of frontend (UI) and backend (API/processing).
  • Supports multiple programming languages.
  • Easy to extend with new features.

Folder Structure


root/
│
├── frontend/   # React/HTML/CSS/JS frontend
├── backend/    # Python/Node.js/other backend API
└── README.md   # Project documentation


Installation

Backend

cd backend

# Install dependencies
# For Node.js:
npm install

# For Python:
pip install -r requirements.txt

# Run the backend server
# Node.js:
npm start

# Python:
python app.py

Frontend

cd frontend

# Install dependencies
npm install

# Run the frontend
npm start
  • Frontend: http://localhost:3000
  • Backend: http://localhost:5000 (or configured port)

Usage

  1. Open the frontend in your browser.
  2. Upload a code file or paste code directly.
  3. Receive automated comments from the AI.
  4. View or download the commented code.

Contributing

  1. Fork the repository.
  2. Create your feature branch: git checkout -b feature-name
  3. Commit your changes: git commit -m "Description"
  4. Push to the branch: git push origin feature-name
  5. Open a Pull Request

License

This project is licensed under the MIT License. See the LICENSE file for details.


📬 Contact

Palguna Shetty Email: palgunashetty26@gmail.com GitHub: palguna26

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors