Giter Site home page Giter Site logo

ai-vscode / genie Goto Github PK

View Code? Open in Web Editor NEW

This project forked from suravshrestha/genie

0.0 0.0 0.0 1.36 MB

Genie, your AI coding assistant, enhances your coding experience by optimizing, explaining, documenting, and generating test cases.

Home Page: https://marketplace.visualstudio.com/items?itemName=suravshrestha.genie-coding-companion

License: MIT License

JavaScript 14.63% TypeScript 85.37%

genie's Introduction

Genie

Overview

Genie is an empowering tool designed to assist coders in optimizing, documenting, and explaining their code. It also facilitates the generation of Unit Test cases for your codebase.

Features

  • Optimizing: Enhance your code's efficiency and performance with Genie's optimization features.
  • Documenting: Generate comprehensive documentation to improve code readability and maintainability.
  • Explaining: Easily understand code logic and functionality through Genie's intuitive explanations.
  • Unit Test Generation: Quickly create Unit Test cases to ensure the robustness of your code. Choose your preferred testing library for seamless integration.

Demonstration

demo.mp4

Getting Started

Prerequisites

Installation

Launch VS Code Quick Open (Ctrl + P), paste the following command, and press enter.

ext install suravshrestha.genie-coding-companion

Usage

  1. Open a Code File: Launch Visual Studio Code and open the code file you want to work on.

  2. Utilize Genie Commands: Access Genie's functionality using commands available in the command palette. Tailor your code with ease using the following commands:

    • Genie: Optimize
    • Genie: Explain
    • Genie: Document
    • Genie: Unit Test

Note: Upon first usage, you will be prompted to input your OpenAI API key in an input box.

Make the most of Genie's capabilities and elevate your coding experience! ๐Ÿš€

Contributing

We appreciate your interest in contributing to Genie! If you encounter bugs or have ideas for new features, please don't hesitate to open an issue or submit a pull request.

Before contributing, please take a moment to review our Contribution Guidelines. These guidelines provide essential information on how to contribute effectively and maintain a collaborative development environment.

Thank you for helping make Genie even better! ๐ŸŒŸ

License

This project is licensed under the MIT License - see the LICENSE file for details.

Happy coding with Genie! ๐Ÿงžโ€โ™‚๏ธ

genie's People

Contributors

suravshrestha 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.