Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ Engion - Modern English Tray Learner & Anki Deck Player

Engion Logo

Lightweight, High-Performance Desktop Tray Application for Micro-Learning Vocabulary & Playing Anki Decks

License MIT Electron React 18 TypeScript Vite


πŸ“Œ Overview

Engion is a modern, non-intrusive desktop application built with Electron, React, and TypeScript. Designed for continuous language acquisition without interrupting your workflow, Engion sits silently in your Windows System Tray and periodically triggers floating micro-learning popups (Flashcards, Fill-in-the-blank, Multiple Choice Quizzes).

It features a Pure Client-Side Anki Package (.apkg) Importer, allowing you to load thousands of vocabulary cards from AnkiWeb directly in memory with instant preview and custom deck organization.


✨ Key Features

πŸ”” 1. System Tray & Floating Micro-Popups

  • Live Tooltip Countdown: Hovering over the tray icon displays real-time countdown to your next review session.
  • Minimize-to-Tray: Minimizing (_) or closing (X) the main window hides it directly to the system tray.
  • Global Hotkeys: Press Alt + E or Ctrl + Shift + E anytime to trigger instant review sessions.
  • Dual Mode Architecture: Non-blocking popup window with continuous session counters (πŸ”₯ Learnt 5 words).

🎴 2. Direct Anki Package (.apkg) Importer & Player

  • 100% In-Memory Parsing: Powered by JSZip for instantaneous parsing of Anki SQLite databases without temporary file pollution.
  • Smart Field Detector: Automatically extracts English words, IPA phonetics, parts of speech, Vietnamese definitions, and example sentences across different Anki field structures.
  • Import Preview Modal: Inspect sample cards, preview word counts, and customize deck names before finalizing import.

πŸ€– 3. Smart Dictionary, Translation & Speech Recognition

  • Auto Lookup: 1-click auto-fill for IPA phonetics, part of speech, Vietnamese translations (Google Translate Engine), and example sentences.
  • πŸŽ™οΈ Pronunciation Evaluator: Integrated Web Speech Recognition API evaluates your spoken pronunciation in real time with visual feedback (βœ… Correct or ❌ Try Again).

⚑ 4. High-Performance Pagination Engine

  • Butter-Smooth 60fps: Pagination engine renders 24/48/96 cards per page, allowing smooth navigation across 5,000+ vocabulary items without DOM lag.

πŸ› οΈ 5. Flexible Deck & Data Management

  • Universal Deletion: Delete any card or custom/preset deck with 1-click.
  • Inline Editing: Quick-edit any word, phonetic, definition, or example directly inside the floating popup card or dashboard.
  • 2-Mode Data Reset: Reset to clean default presets or clean everything for a completely fresh 0-word starting slate.
  • Anki CSV Export: Export starred favorites or full vocabulary banks to UTF-8 .csv format compatible with Anki and Quizlet.

πŸ› οΈ Technology Stack

  • Core: Electron, React 18, TypeScript, Vite
  • Styling: Vanilla CSS with modern Glassmorphism, tailored Dark Theme, and CSS tokens
  • Parsing & Archiving: JSZip, SQLite Anki Database Extractor
  • Icons: Lucide React
  • Browser APIs: Web Speech API, Web Audio API, Speech Synthesis

πŸš€ Quick Start Guide

Prerequisites

  • Node.js (v18.0.0 or higher)
  • npm or yarn

Installation & Local Development

  1. Clone the Repository:

    git clone https://github.com/your-username/engion.git
    cd engion
  2. Install Dependencies:

    npm install
  3. Run Development Server:

    npm run dev
  4. Build Production Executable:

    npm run build

πŸ“š Project Documentation

Detailed architectural, feature, and release notes guides are available:

  • πŸš€ RELEASE_NOTES.md: What's new in Engion v1.1.0 (Enhanced SRS Engine, Roast Badges, Top Weak Words Tracker).
  • πŸ“– FEATURES.md: Complete list of business logic and UI capabilities.
  • πŸ—οΈ ARCHITECTURE.md: Electron IPC bridge, window management, and state flow.
  • πŸ› οΈ DEVELOPMENT_GUIDE.md: Developer environment setup and build scripts.
  • πŸ“œ RULES.md: Coding guidelines and quality standards.

πŸ“„ License

This project is licensed under the MIT License.

Releases

Packages

Contributors

Languages