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

Getting Started

Prerequisites

• Visual Studio Code
• OpenAI API key

Installation

Head over to the Visual Studio Code Marketplace and install the Genie extension.

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! 🧞‍♂️