{"id":22570200,"url":"https://github.com/mohamedsadiq/lightup","last_synced_at":"2025-04-10T13:23:45.189Z","repository":{"id":266759977,"uuid":"884055174","full_name":"mohamedsadiq/LightUp","owner":"mohamedsadiq","description":"AI Genius annotations for every page on the web.","archived":false,"fork":false,"pushed_at":"2025-04-03T16:35:54.000Z","size":60132,"stargazers_count":31,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-03T17:22:35.982Z","etag":null,"topics":["ai","artificial-intelligence","chrome","chrome-browser","chrome-extension","chrome-extensions","chrome-plugin","extension","extensions","giminai","javascipt","javascript","llm","lmstudio","machine-learning","openai","popup","react","typescript"],"latest_commit_sha":null,"homepage":"https://www.boimaginations.com/lightup","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mohamedsadiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-06T03:51:51.000Z","updated_at":"2025-04-03T16:35:58.000Z","dependencies_parsed_at":"2025-02-04T20:23:53.826Z","dependency_job_id":"0a057ccc-f24a-43ea-8187-9d0074dfd651","html_url":"https://github.com/mohamedsadiq/LightUp","commit_stats":null,"previous_names":["mohamedsadiq/lightup"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedsadiq%2FLightUp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedsadiq%2FLightUp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedsadiq%2FLightUp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohamedsadiq%2FLightUp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mohamedsadiq","download_url":"https://codeload.github.com/mohamedsadiq/LightUp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225664,"owners_count":21068078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","artificial-intelligence","chrome","chrome-browser","chrome-extension","chrome-extensions","chrome-plugin","extension","extensions","giminai","javascipt","javascript","llm","lmstudio","machine-learning","openai","popup","react","typescript"],"created_at":"2024-12-08T01:07:53.493Z","updated_at":"2025-04-10T13:23:45.177Z","avatar_url":"https://github.com/mohamedsadiq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## LightUp : AI-Powered Annotations for every page on the web.\n\n![1441](https://pbs.twimg.com/media/GgxiXUPXoAAVQWP?format=jpg\u0026name=medium)\n\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://boimaginations.com/lightup\"\u003e🌐 Website\u003c/a\u003e | \u003ca href=\"https://x.com/sadiq_moo\"\u003e𝕏 Follow us on X\u003c/a\u003e | \u003ca href=\"https://www.boimaginations.com/lightup/getting-started\"\u003e🚀 Getting Started\u003c/a\u003e | \u003ca href=\"https://github.com/mohamedsadiq/LightUp/releases\"\u003e📥 Release Page\u003c/a\u003e |  \u003ca href=\"https://chromewebstore.google.com/detail/lightup-ai-powered-web-an/pncapgeoeedlfppkohlbelelkkihikel?authuser=5\u0026hl=en-GB\"\u003e📥 Download on Chrome\u003c/a\u003e\n\u003c/div\u003e\n\n## ✨  Meet LightUp\nSeamless AI assistance that lives in your browser. No new tabs. No context switching. No interruptions. Just highlight any text and instantly get AI-powered insights.\n\n## 🚀 Quick Start\n\n1. **Download LightUp**\n   - Visit our [Releases page](https://github.com/lightup/releases) or\n   - Get it from [Chrome Web Store](https://chromewebstore.google.com/detail/lightup-ai-powered-web-an/pncapgeoeedlfppkohlbelelkkihikel?authuser=5\u0026hl=en-GB)\n\n2. **Setup**\n   - Pin LightUp to your browser toolbar\n   - Right-click on the LightUp icon in your browser toolbar and then click on \"Options\"\n   - Choose your preferred AI model\n   - Start highlighting text to see the magic!\n\n[📖 Detailed Installation Guide](#installation-for-users) or visit our [Getting Started page](https://www.boimaginations.com/lightup/getting-started)\n\n\n## ✨ Features\n\n- **Smart Text Analysis**: Get instant explanations for complex text passages\n\n- **Multiple Modes**:\n  - 🔍 Explain - Detailed explanations of text\n  - 📝 Summarize - Quick summaries of longer content\n  - 📊 Analyze - Deep analysis of selected content\n  - 🌐 Translate - Translate text into different languages\n  - 💬 Ask Anything - Free-form questions and conversations with the AI\n    - In sidebar layout: Access by moving cursor to the right edge of screen\n    - In floating layout: Use with or without text selection\n    - In centered layout: Experience an immersive conversation with AI in a modal overlay with blurred background\n- **Follow-up Questions**: Ask additional questions about the analyzed content to dive deeper\n- **Flexible AI Backend**:\n  - Use OpenAI's GPT models\n  - Connect to your local LLM (supports llama.cpp, LM Studio, Text Generation WebUI)\n  - Grok-beta by xAI\n  - Google Gemini Models\n    - Gemini 1.0 Pro\n    - Gemini 1.5 Pro\n    - Gemini 1.5 Flash\n- **Dark Mode**.\n![1441](https://github.com/user-attachments/assets/c596a963-fab3-4908-a0f9-5ffe993a07a8)\n\n\n## 📥 Download\n\nDownload the latest version of LightUp from our [Releases page](https://github.com/lightup/releases). Choose the appropriate version for your browser and follow the installation instructions below.\n\n\n## 🚀 Getting Started\n\n## LightUp User Guide\n\n### Installation for users\n\n1. Download the Extension\n  - Go to the LightUp Releases\n  - Download the latest release ZIP file (lightup-vX.X.X.zip) and unzip it.\n\n2. Install in Chrome/Brave\n   - Open Chrome/Brave and go to chrome://extensions/\n   - Enable \"Developer mode\" in the top right corner\n   - Drag and drop the downloaded unzipped file into the extensions page\nOR click \"Load unpacked\" and select the unzipped folder.\n\n\n### Configuration\n\n1. Pin the Extension\n   - Click the puzzle piece icon in your browser toolbar\n   - Find LightUp and click the pin icon to keep it easily accessible\n   - Right-click the LightUp icon and choose \"Options\" to go directly to Settings\n  \n2. Choose your preferred AI backend:\n   - Local LLM (requires running local server)\n   - OpenAI API (requires API key)\n   - Google Gemini (requires Gemini API key and model selection)\n   - Grok-beta by xAI\n3. Save your settings\n\n## 🔧 Usage\n\n1. Select any text on a webpage\n2. A LightUp popup will appear\n3. Get instant AI-powered insights\n4. Ask follow-up questions for deeper understanding\n\n## Keyboard Shortcuts\n\nLightUp supports keyboard shortcuts for quick mode switching:\n\n- `Ctrl+Shift+Z`: Switch to Explain mode\n- `Ctrl+Shift+S`: Switch to Summarize mode\n- `Ctrl+Shift+A`: Switch to Analyze mode\n- `Ctrl+Shift+T`: Switch to Translate mode\n- `Ctrl+Shift+F` / `Command+Shift+F`: Open popup in Free mode (floating, sidebar, or centered based on your settings)\n- `Ctrl+Shift+X`: Toggle LightUp on/off\n- `Ctrl+Shift+R`: Toggle Radically Focus mode\n- `Ctrl+Shift+D`: Toggle Light/Dark theme\n\nAfter setting the mode via shortcut, simply select any text and LightUp will appear with your chosen mode.\n\n## Switching Modes\n\nYou can switch modes in two ways:\n1. Using keyboard shortcuts (see above)\n2. Clicking the LightUp icon in the toolbar to manually select a mode\n\nThis allows you to easily toggle between explaining, summarizing, analyzing, and translating text as per your needs.\n\n\n## 🛠️ Developer Guide: Setting Up LightUp with Plasmo Framework\n\n### Prerequisites\n\n1. **Node.js**: Ensure you have Node.js 16.x or later installed.\n2. **Package Manager**: It's recommended to use `pnpm`, but `npm` or `yarn` will also work.\n\n### Steps to Download and Start Development\n\n1. **Clone the Repository**\n   - Open your terminal and run:\n     ```bash\n     git clone https://github.com/mohamedsadiq/LightUp.git\n     cd LightUp\n     ```\n\n2. **Install Dependencies**\n   - Run the following command to install all necessary packages:\n     ```bash\n     pnpm install\n     ```\n   - If you're using `npm` or `yarn`, replace `pnpm` with your package manager of choice.\n\n3. **Set Up the Development Environment**\n   - Start the development server with live-reloading:\n     ```bash\n     pnpm dev\n     ```\n   - This will watch for file changes and automatically reload your extension in the browser.\n\n4. **Load the Extension in Chrome**\n   - Open Chrome and navigate to `chrome://extensions/`.\n   - Enable \"Developer mode\" in the top right corner.\n   - Click \"Load Unpacked\" and select the `build/chrome-mv3-dev` directory.\n\n5. **Start Developing**\n   - You can now start modifying the source code located in the `src` directory.\n   - Use the Plasmo Framework's features to enhance the extension as needed.\n\n### Additional Resources\n\n- **Plasmo Framework Documentation**: [Plasmo Docs](https://docs.plasmo.com/)\n- **React + TypeScript**: Ensure familiarity with these technologies as they are used extensively in the project.\n- **Framer Motion**: Used for animations within the extension.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohamedsadiq%2Flightup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohamedsadiq%2Flightup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohamedsadiq%2Flightup/lists"}