Skip to content

mohanadft/contextly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contextly

image

Understand words in context while reading

A Chrome extension that helps non-native English readers understand words and phrases based on their context, powered by AI.

Features

  • 🎯 Context-aware explanations - Understand words based on how they're used
  • 💡 Simple English - No dictionary jargon, just clear explanations
  • 🚀 Works everywhere - PDFs, articles, documentation, any webpage
  • Smart suggestions - Click suggested words for quick explanations
  • 🤖 AI-powered - Uses HuggingFace Zephyr-7B for accurate explanations

How It Works

  1. Select text containing a word you don't understand
  2. Right-click and choose "Explain word in context"
  3. Pick a suggested word or type your own
  4. Get a simple, context-based explanation

Project Structure

contextly/
├── extension/     # Chrome extension (Manifest V3)
├── backend/       # Express API with HuggingFace integration
└── README.md      # This file

Quick Start

1. Backend Setup

cd backend
npm install
cp .env.example .env
# Add your HuggingFace token to .env
npm start

Get a HuggingFace token: https://huggingface.co/settings/tokens

2. Extension Setup

  1. Open Chrome and go to chrome://extensions/
  2. Enable "Developer mode"
  3. Click "Load unpacked"
  4. Select the extension folder
  5. Done! Right-click any selected text to use

Documentation

Tech Stack

Extension:

  • Chrome Manifest V3
  • Vanilla JavaScript
  • Context Menus API

Backend:

  • Node.js + Express
  • HuggingFace Zephyr-7B-Beta
  • OpenAI SDK (for HF compatibility)

Use Cases

  • Reading technical documentation
  • Understanding idioms and phrasal verbs
  • Learning English through context
  • Reading academic papers
  • Browsing foreign language resources

Contributing

Contributions welcome! This is an MVP - keep it simple and focused.

License

MIT


Built for non-native English readers who want to understand words in context, not just their dictionary definitions.

About

Context-aware word explanations for readers in Chrome.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors