Git Product home page Git Product logo

code-whisperer's Introduction

CodeWhisperer

CodeWhisperer is a web-based application designed to facilitate insightful interactions between users and their code repositories. By leveraging cutting-edge AI technologies, CodeWhisperer provides intelligent summaries and detailed explanations, engaging users in a conversational interface that demystifies complex codebases.

Overview

The app integrates the Express framework within a Node.js environment, utilizing MongoDB for data persistence. For UI elegance and interactivity, Bootstrap is employed. The core functionality is built around OpenAI's powerful language models, enabling the app to generate concise text summaries and interactive Q&A sessions about a user's code repository.

Features

  • Submits GitHub repository URLs and email addresses for processing
  • Clones GitHub repositories and communicates with OpenAI API to generate summaries
  • Provides interactive explanations of code via a unique link, offering insights into repositories
  • Utilizes Sendgrid for email notifications upon the completion of repository analysis
  • Proffers a unique and engaging way to understand and engage with one's programming projects

Getting started

Requirements

  • Node.js
  • MongoDB
  • A Sendgrid account for email services
  • An OpenAI API key for natural language processing

Quickstart

  1. Ensure that MongoDB is running on your system.
  2. Clone the repository to your local machine.
  3. Install node modules by running npm install.
  4. Set up the necessary environment variables in an .env file.
  5. Start the application with npm start, and navigate to localhost:3001 on your web browser.

License

Copyright (c) 2024.

code-whisperer's People

Contributors

jeeshumittal7 avatar

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.