|
1 | 1 | # DailyWordPro
|
2 |
| -WordyBar is a sleek and minimalistic macOS menu bar app designed to improve your vocabulary, one word at a time |
| 2 | + |
| 3 | +DailyWordPro is a sleek and minimalistic macOS menu bar app designed to improve your vocabulary, one word at a time. Perfect for GRE preparation, academic growth, or anyone looking to enhance their language skills. The app fetches a word, its meaning, and an example sentence from a connected Google Sheet, making vocabulary learning seamless and enjoyable. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- **Daily Word Display**: Shows a new word along with its meaning and usage in a sentence. |
| 10 | +- **Interactive Learning**: |
| 11 | + - Mark words as "Memorized" directly from the app. |
| 12 | + - Click on the word to search for it on Google for further exploration. |
| 13 | +- **Beautiful UI**: Clean and minimal design with hover effects and customizable colors that adapt to macOS's light and dark modes. |
| 14 | +- **Custom Word Bank**: Integrates with your Google Sheet for easy customization of words. |
| 15 | + |
| 16 | +--- |
| 17 | + |
| 18 | +## How It Works |
| 19 | + |
| 20 | +1. **Google Sheets Integration**: |
| 21 | + - The app fetches words from a Google Sheet containing the following columns: |
| 22 | + - `Word` |
| 23 | + - `Meaning` |
| 24 | + - `Example` |
| 25 | + - `Memorized` (optional: `TRUE`/`FALSE` to track progress) |
| 26 | + |
| 27 | +2. **Random Word Selection**: |
| 28 | + - The app displays a random word from the non-memorized words in your sheet. |
| 29 | + |
| 30 | +3. **Interactive Actions**: |
| 31 | + - Mark a word as "Memorized." |
| 32 | + - Load another random word using the "Next Word" button. |
| 33 | + |
| 34 | +4. **Google Search**: |
| 35 | + - Click on any word to open a Google search page for further exploration. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +## Setup Instructions |
| 40 | + |
| 41 | +### Prerequisites |
| 42 | + |
| 43 | +- macOS system with Xcode installed. |
| 44 | +- A Google Sheet containing your word bank. |
| 45 | +- A Google API Key with access to the Google Sheets API. |
| 46 | + |
| 47 | +### Steps |
| 48 | + |
| 49 | +1. **Clone the Repository**: |
| 50 | + ```bash |
| 51 | + git clone https://github.com/pycoder2000/DailyWordPro.git |
| 52 | + cd DailyWordPro |
| 53 | + ``` |
| 54 | + |
| 55 | +2. **Open the Project**: |
| 56 | + - Open `DailyWordPro.xcodeproj` in Xcode. |
| 57 | + |
| 58 | +3. **Configure Google Sheets API**: |
| 59 | + - Create a Google API key from the [Google Cloud Console](https://console.cloud.google.com/). |
| 60 | + - Update your API key and Google Sheet ID in `ContentView.swift`: |
| 61 | + ```swift |
| 62 | + let sheetID = "YOUR_GOOGLE_SHEET_ID" |
| 63 | + let apiKey = "YOUR_GOOGLE_API_KEY" |
| 64 | + ``` |
| 65 | + |
| 66 | +4. **Run the App**: |
| 67 | + - Select "My Mac" as the target device in Xcode. |
| 68 | + - Click the **Run** button (▶️) to launch the app. |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +## Usage |
| 73 | + |
| 74 | +1. **Launch the App**: |
| 75 | + - Once running, the app will appear in your macOS menu bar. |
| 76 | + |
| 77 | +2. **Interact with the App**: |
| 78 | + - **View Word**: Displays the word, its meaning, and an example sentence. |
| 79 | + - **Mark Memorized**: Click "Memorized it" to mark the current word as memorized. |
| 80 | + - **Next Word**: Click "Next Word" to learn another word. |
| 81 | + - **Explore**: Click on the word to open a Google search for deeper learning. |
| 82 | + |
| 83 | +3. **Customize Your Words**: |
| 84 | + - Update your Google Sheet with new words, meanings, and examples. |
| 85 | + - The app will fetch the updated data automatically. |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +## Project Structure |
| 90 | + |
| 91 | +``` |
| 92 | +📦DailyWordPro |
| 93 | + ┣ 📂DailyWordPro |
| 94 | + ┃ ┣ 📜ContentView.swift # Main UI and logic for the app |
| 95 | + ┃ ┣ 📜DailyWordProApp.swift # App entry point |
| 96 | + ┃ ┗ 📂Assets.xcassets # App icons and color assets |
| 97 | + ┣ 📂DailyWordPro.xcodeproj # Xcode project configuration |
| 98 | + ┗ 📜README.md # Project documentation |
| 99 | +``` |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +## Contributing |
| 104 | + |
| 105 | +Contributions are welcome! If you have ideas for new features or enhancements, feel free to create an issue or submit a pull request. |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +## License |
| 110 | + |
| 111 | +This project is licensed under the MIT License. See the [`LICENSE`](/LICENSE) file for details. |
| 112 | + |
| 113 | +--- |
| 114 | + |
| 115 | +## Screenshots |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +## Acknowledgments |
| 120 | + |
| 121 | +- **Google Sheets API** for seamless integration with a customizable word bank. |
| 122 | +- Inspired by the idea of daily vocabulary improvement. |
| 123 | + |
| 124 | +--- |
| 125 | + |
| 126 | +Happy Learning! 🚀 |
0 commit comments