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.
- 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.
- Node.js
- MySQL Server
- Clone the repository:
git clone https://github.com/FlareCoding/cs411-project.git
- Install dependencies:
npm install
- Configure your environment variables.
- Start the server:
npm start
- Sign in using your Google account.
- Link your GitHub repository.
- Select a file from your repository.
- Generate comments and view the suggestions.
- Apply comments to your code as needed.
Gianna Sfrisi - [email protected] Albert Slepak - [email protected]