Skip to content

[🏆 MHacks 2024 Best Developer Tool] An AI Coding Assistant Empowering Tech Education with Step-by-Step Guidance, Not Direct Solutions

License

Notifications You must be signed in to change notification settings

zichenzhang04/GenHint

Repository files navigation


Logo

[🏆 MHacks 2024 Best Developer Tool] GenHint

Empowering Tech Education with Step-by-Step Guidance, Not Direct Solutions

Website · Demo Slides · Demo Video

GitHub last commit GitHub Created At GitHub contributors

Table of Contents
  1. Highlights
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

Highlights

demo.mp4

Highlights

👥 Learning with unparalleled companionship: GenHint goes beyond simple guidance. Our approach provides step-by-step instructions, but we don't stop there. If you want to dive deeper into any part of a process, just select the step, and we’ll provide detailed, contextual insights to ensure you fully grasp each concept. It's like having a mentor by your side, ready to explain each move.

🚀 Instant reponse with no pressure: Thanks to Groq, we are avaliable to help our users using the most advanced models at lightning speeds with no pressure on personal devices. Whether it is a workstation, or a thin and light, everyone can learn to code intelligently without worries.

(back to top)

Usage

Here's how to use our extension:

  • Highlight a comment and type cmd+shift+g(MacOS)/ctrl+shift+g(Windows) for structurizing (break down a problem into TODOs)
  • Highlight a comment and type cmd+shift+e/ctrl+shift+e for elaboration (break down a TODO into specific subtasks)
  • Highlight a code region and type cmd+shift+r/ctrl+shift+r for review (review finished codes)

We don’t just teach you the basics; we offer the opportunity to explore each instruction in detail. Whether you’re stuck on a specific step or simply curious to learn more, our AI-driven tool lets you uncover deeper explanations exactly when you need them, making learning intuitive and personalized.

For more examples, please refer to our project website

For more information on DevPost, please refer to DevPost website

(back to top)

Roadmap

  • Implemented Structurize Module
  • Implemented Elaboration Module
  • Implemented Review Module

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b your-branch-name).
  3. Commit your changes (git commit -m 'Describe your changes').
  4. Push your branch (git push origin your-branch-name).
  5. Open a Pull Request.

If you have ideas for improving the project, feel free to open an issue with the "enhancement" tag. And if you like the project, don't forget to give it a star!

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

Thanks to Warp and Groq for providing the computation platform for this project! If you want to build your own LLM-based tool, check out Groq and see if they could power your project!

We also thank MHacks for giving us this opportunity to meet with like-minded people and collaborate on this wonderful project, if you also want to have this experience, check out all that MHacks has to offer!

(back to top)

About

[🏆 MHacks 2024 Best Developer Tool] An AI Coding Assistant Empowering Tech Education with Step-by-Step Guidance, Not Direct Solutions

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •