Skip to content

Latest commit

 

History

History
44 lines (23 loc) · 2.8 KB

README.md

File metadata and controls

44 lines (23 loc) · 2.8 KB
Raw

CritiqueCheck

Note: Unfortunately, we are unable to provide a code review from our deployed project at this time. This is due to our current lack of credit to maintain usage of the OpenAI API, which our project utilizes.

Code Review Automation

This web application utilizes OpenAI's natural language processing capabilities to automate code reviews. It provides an efficient and comprehensive way to review submitted code, offering valuable comments on coding style, adherence to industry standards, and suggestions for further development.

Features

  • Automated Code Reviews : The application employs OpenAI's natural language processing to analyze and review submitted code, saving time and effort in manual code inspections.

  • Style and Standards Feedback : Receive valuable insights on coding style, ensuring consistency and adherence to best practices. The application highlights areas where improvements can be made to enhance code readability and maintainability.

  • Development Suggestions : Get suggestions for further development and optimization of the code. The application identifies potential enhancements, potential bugs, or opportunities for increased performance.

  • Customization : Tailor the code review process to your specific needs by setting preferred style guidelines and rules. Customize the application to align with your team's coding conventions and industry standards.

How It Works

  • Submit your code : Upload your code to the web application, providing the necessary details and context for the review.

  • Automated Review : The application utilizes OpenAI's natural language processing capabilities to analyze the code thoroughly. It examines coding style, industry standards, and potential areas for improvement.

  • Review Report : Receive a detailed review report highlighting the strengths and weaknesses of your code. The report includes specific comments and suggestions for enhancing code quality and meeting best practices.

  • Iterative Improvement : Utilize the feedback provided by the application to iterate on your code. Make necessary changes based on the recommendations and submit the updated code for further review, if desired.

Getting Started

To run this web application locally or deploy it to a server, follow the steps below:

  • Clone the repository

  • Install dependencies : npm install

  • Build and run the application : npm run start

  • Access the application : Open your browser and navigate to your localhost to access the code review automation web application.

  • Make sure to create a .env file and include your OpenAI key. You can refer to the .env.example file for an example of how to structure the .env file.

Demo Video

Project Overview Video