Code Interpreter

Welcome to the Code Assistant project! This tool helps users get code corrections, completions, and explanations for their code. Simply provide the repository github link and problem description, and the Code Assistant will generate a helpful response.

Getting Started

To use the Code Assistant, follow these steps:

  1. Clone this repository to your local machine.

    git clone https://github.com/your-username/code-assistant.git
  2. Install the necessary dependencies using npm.

    npm install
  3. Set up your API key by creating a .env file in the project root directory and adding your OpenAI API key.

REACT_APP_API_KEY=your-api-key-here
  1. Start the development server.
npm start
  1. Access the Code Assistant frontend at http://localhost:3000 in your web browser.

How It Works

The Code Assistant uses the OpenAI GPT-3.5 Turbo model to understand and provide responses to code and problem descriptions. When you submit a request, it sends the code and description to the OpenAI API and displays the response on the landing page.

Usage

  1. Enter your code in the input field.
  2. Describe the problem you're facing in the provided text area.
  3. Click the "Submit" button.
  4. The Code Assistant will provide a helpful response, including code corrections and explanations.

Scope

The current version of the Code Assistant utilizes the OpenAI GPT-3.5 Turbo model, which may incur costs for API usage beyond the free tier. However, we are actively working on expanding the project's capabilities:

Fine-Tuned Model: We are in the process of developing our own fine-tuned language model specifically designed for code assistance. This model will provide improved accuracy and efficiency while reducing dependency on external APIs.

Future Aspects

I have ambitious plans for the future of the Code Assistant:

Enhanced Language Support: I aim to support multiple programming languages and technologies, catering to a broader audience of developers.

Integration with IDEs: We plan to develop plugins and extensions that seamlessly integrate the Code Assistant into popular integrated development environments (IDEs).

Screenshots

A visual of its results Screenshot 2023-09-17 181646

image