🎓 Magic English

• Smart Word Analysis: Get instant definitions, translations, examples, and usage tips
• Sentence Scoring: AI evaluates your sentences and provides detailed feedback
• Magic Search: Quick lookup from anywhere with a floating search window

• Multiple Databases: Organize words by topics, courses, or projects
• Rich Word Details: Store definitions, Vietnamese translations, examples, and notes
• Flexible Database Paths: Choose where to store your vocabulary databases

• Learning Streaks: Track daily learning habits with streak counters
• Activity Calendar: Visualize your learning activity over time
• Statistics Dashboard: Monitor words learned, sentences scored, and more
• Achievement System: Unlock badges as you reach milestones

• Modern Design: Clean, professional interface with smooth animations
• Dark/Light Themes: Choose your preferred color scheme
• Responsive Layout: Optimized for various screen sizes
• Keyboard Shortcuts: Power-user features for faster workflows

• English interface with Vietnamese translations
• Extensible i18n system for additional languages

1. Go to Releases
2. Download Magic English-1.0.0-win-x64.exe
3. Run the installer and follow the wizard
4. Launch Magic English from Start Menu or Desktop

1. Download Magic English-portable.exe
2. Place it in your preferred folder
3. Run directly - no installation needed!

# Clone repository
git clone https://github.com/yourusername/desktop_vocab.git
cd desktop_vocab

# Install dependencies
npm install

# Run in development mode
npm start

# Build for production
npm run build:win

1. Launch the app - Choose or create your first vocabulary database
2. Add your first word - Type a word and click "Search & Add"
3. AI analyzes it - Get instant definitions, examples, and translations
4. Build your streak - Come back daily to maintain your learning habit
5. Track progress - Check Stats & Streaks tab to see your growth

desktop_vocab/
├── electron/               # Main process
│   ├── main.js            # App entry point
│   ├── preload.cjs        # IPC bridge
│   ├── ipcHandlers.js     # IPC handlers
│   └── services/          # Business logic
│       ├── jsonStore.js   # Database management
│       ├── userProfileStore.js  # User data & achievements
│       ├── dbPathsStore.js      # Path management
│       └── claudeService.js     # AI client
├── src/
│   ├── renderer/          # Renderer process (main UI)
│   │   ├── index.html
│   │   ├── app.js
│   │   └── styles.css
│   └── magic-search/      # Floating search window
│       ├── magic-search.html
│       ├── magic-search.js
│       └── magic-search-claude.css
├── static/                # Assets (icons, images)
├── scripts/               # Build automation
├── .github/workflows/     # CI/CD automation
└── package.json

• Node.js 20+ and npm
• Windows 10/11 (for building Windows installer)
• ImageMagick (for icon generation): choco install imagemagick

# Install dependencies
npm install

# Run in development mode with hot-reload
npm run dev

# Run in production mode
npm start

# Format code
npm run format

# Lint code
npm run lint

# Build installer (x64)
npm run build:win

# Build 32-bit installer
npm run build:win32

# Build portable version
npm run build:portable

# Build unpacked directory only
npm run build:dir

Output will be in build-output/ folder.

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

See RELEASE.md for detailed version history.

This project is licensed under the BSD 3-Clause License - see LICENSE.txt for details.

• Ollama Cloud for providing the AI API
• Electron team for the amazing framework
• Claude Sonnet 4.5 for powering the AI features
• All contributors and users of Magic English

• 🐛 Report a bug
• 💡 Request a feature
• 💬 Discuss