Skip to content

abdallahbahrawi1/lexi-extention

Repository files navigation

LexiLearn - Chrome Extension

LexiLearn is a Chrome extension designed to enhance vocabulary learning and comprehension by providing users with quick definitions, translations, and lexical analysis directly from the browser.

🌟 Features

  • 📚 Instant Definitions: Get quick word definitions with a simple highlight.
  • 🌐 Translation: Translate words or phrases into multiple languages on-the-fly.
  • 🧠 Contextual Learning: Offers synonyms, antonyms, and usage examples.
  • 💾 Save & Review: Save frequently looked-up words to your personal vocabulary list for future review.
  • 🔧 Custom Lexicon: Users can customize their learning with domain-specific terminology.
  • 🖥️ User-Friendly Interface: Designed to be intuitive, with a clean, easy-to-navigate interface.

🛠️ Installation

  1. Clone or download this repository:
    git clone https://github.com/abdallahbahrawi1/lexi-extention.git
  2. Build the extension.
    yarn watch
  3. Open Chrome and go to chrome://extensions/.
  4. Enable "Developer mode" by toggling the switch in the top right corner.
  5. Click the "Load unpacked" button and select the dist folder under the extension's directory (lexilearn-extension folder).
  6. The LexiLearn extension will now be added to your Chrome browser!

📖 How to Use

  1. Once installed, you'll see the LexiLearn icon in your Chrome toolbar.
  2. Highlight any word or phrase on a webpage.
  3. Right-click the highlighted word and choose:
  • "LexiLearn: Define" for definitions.
  • "LexiLearn: Translate" for translations.
  1. The definition or translation will appear in a pop-up for quick access.
  2. Save words by clicking on the "Save" button for future review in the extension's word list.

Manifest Permissions

The extension requests the following permissions:

  • activeTab: Access to the current webpage's content.
  • contextMenus: Add custom right-click context menu options.
  • storage: Store user data such as saved words for later use.

Adding New Features

Feel free to fork this repository and add your features! Here are some ideas to get started:

  • Integrate with APIs for more comprehensive lexical databases.
  • Add pronunciation audio for words.
  • Expand support for more languages in translation.

🤝 Contributing

We welcome contributions! To contribute:

  1. Fork the project.
  2. Create your feature branch:
git checkout -b feature/new-feature
  1. Commit your changes:
git commit -m 'Add some feature'
  1. Push to the branch:
git push origin feature/new-feature
  1. Open a pull request.

📝 Support & Feedback

For any issues, feedback, or feature requests, feel free to open an issue on GitHub or contact me directly at [[email protected]].

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published