Git Product home page Git Product logo

cs411-project's Introduction

CODE COMMENTOR

Description

This project is a website designed to streamline the code commenting process for developers. It integrates React and JavaScript for the frontend, uses a MySQL database for data management, and incorporates the GitHub API and ChatGPT API for functionality. Through Google authentication, users can link their GitHub repository, select a coding file, and the website will generate insightful comments to be included throughout their code.

Features

  • GitHub Integration: Link your GitHub repository with ease.
  • File Selection: Choose any coding file from your linked repository for comment generation.
  • Automated Comment Generation: Leverages the power of ChatGPT to create relevant comments.
  • User Authentication: Secure sign-in through Google authentication.

Getting Started

Prerequisites

  • Node.js
  • MySQL Server

Installation

  1. Clone the repository: git clone https://github.com/FlareCoding/cs411-project.git
  2. Install dependencies: npm install
  3. Configure your environment variables.
  4. Start the server: npm start

Usage

  1. Sign in using your Google account.
  2. Link your GitHub repository.
  3. Select a file from your repository.
  4. Generate comments and view the suggestions.
  5. Apply comments to your code as needed.

Contact

Gianna Sfrisi - [email protected] Albert Slepak - [email protected]

Video Link

Watch the video

cs411-project's People

Contributors

flarecoding avatar

Stargazers

Gianna Sfrisi avatar

Watchers

 avatar

Forkers

giannasfrisi

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.