suimiuil

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

Report Bug · Request Feature

Table of Contents

• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Google Translate Setup
• 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

• WXT
• React
• TypeScript
• Bootstrap 5
• Google Cloud Translation API (Basic v2)
• ABAIR Webreader TTS

(back to top)

Getting Started

Follow these steps to run the extension locally.

Prerequisites

• Node.js 18+
• npm 9+
• Chrome or Firefox

Installation

1. Clone the repository:

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

2. Go to the frontend workspace:

cd suimiuil/frontend

3. Install dependencies:

npm install

4. 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:

Home Screen

Extension View

Translation Popover

Learning Mode

API Key Settings

(back to top)

Contributing

Contributions are welcome.

1. Fork the repository.
2. Create a feature branch:

git checkout -b feature/your-feature

3. Commit your changes:

git commit -m "feat: add your feature"

4. Push to your fork and open a pull request.

(back to top)

License

Distributed under the Apache License 2.0. See LICENSE for details.

(back to top)

Contact

• GitHub: @vijethph, @andrewdempsey2018
• Repository: https://github.com/vijethph/suimiuil

(back to top)

Acknowledgments

• Best README Template
• WXT Documentation
• Bootstrap Documentation
• Google Cloud Translation API v2 Docs
• ABAIR Webreader
• Flaticon logo credit: Celtic icons created by Freepik - Flaticon

(back to top)