/hey-buddy

For Vertex AI agent builder Hackthon

Primary LanguageJavaScript

Hey Buddy 🌟

Welcome to Hey Buddy! Your friendly and professional interactive learning companion designed to assist users while browsing educational content online.

Project Overview 📚

Hey Buddy is an intelligent extension that aims to be your learning partner. Whether you're a student, a professional, or someone who loves to learn, Hey Buddy is here to enhance your online educational experience.

Key Features ✨

  • Technical Assistance: Answer user technical questions to help understand complex topics.
  • Content Summarization: Summarize educational content to highlight key points.
  • Interactive Learning: Ask users questions to check their knowledge and reinforce learning.
  • Motivational Support: Provide emotional support and motivational quotes to keep users engaged and motivated.
  • Personalized Responses: Adapt responses based on the user's age and selected persona (Friendly or Professional).

Personas 🧑‍🤝‍🧑

  • Friendly: Casual, includes emojis and jokes to make learning fun.
  • Professional: Formal and precise, perfect for a serious learning environment.

Installation 🛠️

To get started with Hey Buddy, follow these simple steps:

1. Clone the Repository

git clone git@github.com:ahzia/hey-buddy.git

2. Navigate to the Project Directory

cd hey-buddy

3. Load the Extension in Your Browser

For Chrome

  1. Open Chrome and navigate to chrome://extensions/.
  2. Enable Developer mode by clicking the toggle switch in the top right corner.
  3. Click on Load unpacked and select the hey-buddy directory.

For Firefox

  1. Open Firefox and navigate to about:debugging#/runtime/this-firefox.
  2. Click on Load Temporary Add-on.
  3. Select the manifest.json file inside the hey-buddy directory.

4. Start Using Hey Buddy

Once the extension is loaded, click on the Hey Buddy icon in your browser to open the settings and start customizing your learning experience.

Usage Instructions 📖

  1. Open the Settings: Click on the Hey Buddy icon in your browser.
  2. Customize Your Experience:
    • Enter your name, chat name, and age.
    • Choose the agent personality: Friendly or Professional.
  3. Save Settings: Click the save button to apply your preferences.
  4. Start Learning: Hey Buddy will assist you as you browse educational content online, providing answers, summaries, and interactive questions.

Contribution 🤝

We welcome contributions from the community. To contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a pull request.

License 📜

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


Happy Learning with Hey Buddy! 🎉

If you have any questions or need further assistance, feel free to open an issue or contact us directly. We're here to help you on your learning journey! 🚀