https://github.com/ygsgdbd/vastwords

📚 A macOS vocabulary app that helps you collect and learn English words from daily reading, featuring clipboard monitoring and system dictionary integration.
https://github.com/ygsgdbd/vastwords

clipboard combine dictionary education macos menubar-app offline offline-first productivity swift swifterswift swiftui tuist vocabulary-learning

Last synced: 3 months ago
JSON representation

📚 A macOS vocabulary app that helps you collect and learn English words from daily reading, featuring clipboard monitoring and system dictionary integration.

• Host: GitHub
• URL: https://github.com/ygsgdbd/vastwords
• Owner: ygsgdbd
• License: mit
• Created: 2024-12-13T07:19:45.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-22T10:40:58.000Z (7 months ago)
• Last Synced: 2025-02-13T20:17:29.239Z (5 months ago)
• Topics: clipboard, combine, dictionary, education, macos, menubar-app, offline, offline-first, productivity, swift, swifterswift, swiftui, tuist, vocabulary-learning
• Language: Swift
• Homepage:
• Size: 854 KB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VastWords 📚



  



[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ygsgdbd/VastWords)](https://github.com/ygsgdbd/VastWords/releases)

[![GitHub](https://img.shields.io/github/license/ygsgdbd/VastWords)](https://github.com/ygsgdbd/VastWords/blob/main/LICENSE)

[![Platform](https://img.shields.io/badge/platform-macOS%2013%2B-brightgreen)](https://github.com/ygsgdbd/VastWords)

[![Swift](https://img.shields.io/badge/Swift-5.9-orange.svg)](https://swift.org)

[![Xcode](https://img.shields.io/badge/Xcode-15.0%2B-blue)](https://developer.apple.com/xcode/)

[![SwiftUI](https://img.shields.io/badge/SwiftUI-3.0-blue)](https://developer.apple.com/xcode/swiftui)

[🇨🇳 中文文档](README_zh.md) | English

VastWords is a macOS vocabulary application designed to help you quickly collect and learn English words encountered during daily reading. It automatically monitors the clipboard for English words and provides system dictionary lookup functionality. The application runs completely offline, with all data stored locally to ensure your privacy.



  



## 📥 Installation

### 🍺 Via Homebrew (Recommended)

```bash

brew install ygsgdbd/tap/vastwords

```

### 💻 Manual Installation

1. Download the latest release from the [Releases](https://github.com/ygsgdbd/VastWords/releases) page

2. Drag VastWords.app to your Applications folder

3. Launch VastWords from Applications or Spotlight

## 🛠 Tech Stack

- SwiftUI + MVVM Architecture

- CoreData + CoreStore for Data Persistence

- Vision Framework for OCR

- Natural Language for Lemmatization

- Combine + Async/Await for Asynchronous Operations

- Tuist for Project Management

- SwiftLint + SwiftFormat for Code Standards

## ✨ Features

- 🔄 Smart Monitoring

  - Automatic clipboard text monitoring

  - Image OCR support (using system Vision framework, offline and secure)

  - Automatic English word extraction

  - Smart word lemmatization (e.g., running → run, cities → city)

- 📚 Integrated macOS system dictionary for real-time word definitions

- ⭐️ Star important words

- 🔍 Word search and filtering

- 📊 24-hour word collection statistics

- 📥 Word list export

- 🚀 Launch at login support

- ⭐️ High-performance storage

- 🎯 Performance optimized

## 🔐 Privacy & Security

- 🔒 Completely offline operation

- 💾 Local data storage only

- 🛡️ Uses system built-in features

- 🤝 No user data collection

- 📱 Minimal permissions required

## ⚠️ Limitations

- Text length limit: 10,000 characters

- Word length limit: 2-45 characters

- Automatic filtering of common function words (e.g., a, the, in)

## 💻 System Requirements

- macOS 13.0 or later

- Apple Silicon or Intel processor

## 🔧 Development Setup

- Xcode 15.0+

- Swift 5.9+

- SwiftUI

- [Tuist](https://tuist.io) 3.0+

## 📦 Dependencies

- [CoreStore](https://github.com/JohnEstropia/CoreStore)

- [Defaults](https://github.com/sindresorhus/Defaults)

- [SwifterSwift](https://github.com/SwifterSwift/SwifterSwift)

- [SwiftUIX](https://github.com/SwiftUIX/SwiftUIX)

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

### 📝 Third-Party Licenses

This project uses the following open source components:

- [CoreStore](https://github.com/JohnEstropia/CoreStore) - MIT License

- [Defaults](https://github.com/sindresorhus/Defaults) - MIT License

- [SwifterSwift](https://github.com/SwifterSwift/SwifterSwift) - MIT License

- [SwiftUIX](https://github.com/SwiftUIX/SwiftUIX) - MIT License