suimiuil

Browser extension for learning Irish while browsing.
Explore the repository »

Report Bug · Request Feature

About The Project
- Built With
Getting Started
Usage
Project Structure
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

suimiuil is a browser extension built with WXT, React, and TypeScript. It scans webpages for long words, translates them from English to Irish, and supports hover translations, learning mode replacements, and pronunciation via text-to-speech.

Current implementation is focused in frontend/. The backend/ directory is reserved for future services.

(back to top)

Built With

(back to top)

Getting Started

Follow these steps to run the extension locally.

Prerequisites

Node.js 18+
npm 9+
Chrome or Firefox

Installation

Clone the repository:

git clone https://github.com/vijethph/suimiuil.git

Go to the frontend workspace:

cd suimiuil/frontend

Install dependencies:

npm install

Start extension development:

npm run dev

Optional Firefox mode:

npm run dev:firefox

Google Translate Setup

The extension uses this endpoint for translation:

POST https://translation.googleapis.com/language/translate/v2

You can provide the API key in either way:

Recommended: Open the extension popup and save the key in settings.
Fallback: Add key in frontend/.env.local:

WXT_GOOGLE_TRANSLATE_API_KEY=your_api_key

(back to top)

Usage

Basic Mode: Highlights words with 10+ characters and shows Irish translation in a hover popover.
Learning Mode: Replaces long words with Irish translations on the page.
Text-to-Speech: Click the speaker icon next to translated text to hear pronunciation.
Dialect Selection: Choose Connacht, Munster, or Ulster dialect in popup settings.

Screenshots: