Skip to content

aravind-manoj/useless-project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fumbl-iFy: Turning Seriousness into Silliness!

Fumbl-iFy is a Chrome extension designed to inject a playful twist into any topic by generating absurd or nonsensical responses. This extension is usable on any website with text input fields and allows users to activate the feature with a simple command: ify("your text"). The input text is then sent to an AI model hosted on Hugging Face, which generates a useless response that appears in the input field where the command was invoked.


🎯 Team: console.log()

  • Team Lead: Aravind Manoj - SJCET Palai
  • Member 2: Abin Thomas - SJCET Palai
  • Member 3: Abin Raju Daniel - SJCET Palai

Project Description

Fumbl-ify is a Chrome extension that takes any topic and humorously rephrases it into an exaggerated, silly version. It’s designed to bring a bit of levity and laughter to otherwise mundane or serious topics.

The Problem (that doesn't exist)

People often take things way too seriously. Important or formal topics can be, let’s face it, a bit dry. We thought—what if there were a way to add a splash of humor to any topic?

The Solution (that nobody asked for)

Our extension, Fumbl-ify, injects ridiculous, humorous spins on user-provided topics. It’s like having your own personal jester who turns mundane topics into quirky, amusing ones at the click of a button!


Technical Details

Technologies/Components Used

For Software:

  • Languages: TypeScript, JavaScript, Python
  • Frameworks: React, NextJs, Tailwind CSS
  • Backend: FastAPI with Hugging Face API
  • AI Model: HuggingFaceH4/zephyr-7b-beta
  • Libraries: webextension-polyfill for chrome extension
  • Tools: Chrome Developer Tools, VS Code, Git

For Hardware:

No hardware components are required as this is a purely software-based project.

Implementation

  1. User Interaction: The user types ify("some text") into any input field or textarea on a website.
  2. Capturing Input: The extension utilizes the webextension-polyfill library to interact with the DOM, capturing the user’s input when the command is detected.
  3. Processing Input: The captured text is sent to the AI model HuggingFaceH4/zephyr-7b-beta hosted on Hugging Face, which generate a humorously exaggerated or absurd response.
  4. Displaying Output: The generated response is displayed back in the input field and consists of useless or nonsensical content, providing a humorous twist to the original topic.

Installation

Clone the repository:

git clone https://github.com/aravind-manoj/useless-project

For setting up website:

cd useless-project/web
npm install

For local testing:
npm run dev

To build the site for production:
npm run build

For setting up Hugging Face API:

cd useless-project/backend

To install dependencies:
pip3 install -r requirements.txt

To start the backend:
uvicorn main:app --port 8000

Note: Hugging Face API token is required and it must be set in environment as HF_TOKEN. API Docs

For setting up chrome extension:

cd useless-project/chrome-extension
npm install

To build the extension for production:
npm run build

Project Documentation

API Permissions

These are the required permissions for Hugging Face API Token: hfapi

Backend API

api

Extension UI

extension-ui

Web UI

web-ui

Responsive UI

responsive-ui

Project Demo

How to use the chrome extension:

demo.mov

Additional Demo

How to build and install chrome extension:

extension-install.mov

Team Contributions

Aravind Manoj: AI, Backend, Extension

Abin Thomas: Extension UI, Extension, Web UI

Abin Raju Daniel: Extension UI, Web UI, Documentation