Skip to content

README.md

Latest commit

 

History

History
70 lines (50 loc) · 1.2 KB

README.md

File metadata and controls

70 lines (50 loc) · 1.2 KB

Code Comment Generator

A web application that helps developers generate meaningful code comments using AI. This project consists of a frontend and backend component.

Project Structure

.
├── frontend/     # Frontend application
└── backend/      # Backend server

Features

  • AI-powered code comment generation
  • Modern web interface
  • RESTful API backend
  • Support for multiple programming languages

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • Python 3.8 or higher
  • Git

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/code-comment-generator.git
cd code-comment-generator
  1. Install backend dependencies:
cd backend
npm install
  1. Install frontend dependencies:
cd frontend
npm install

Running the Application

  1. Start the backend server:
cd backend
npm start
  1. Start the frontend development server:
cd frontend
npm start

The application will be available at http://localhost:3000

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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