Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 3.71 KB

README.md

File metadata and controls

88 lines (62 loc) · 3.71 KB
Raw

Vocabulary Booster 🎓🚀

Welcome to Vocabulary Booster! 🌟

Overview

Vocabulary Booster is a desktop application designed to help you continuously expand your vocabulary in a highly effective manner. Unlike 99% of other language apps, you don't need to carve out specific time slots or concentrate solely on the app. Instead, Vocabulary Booster seamlessly integrates into your daily routine, allowing you to learn new words while you engage in other activities.

VIDEO DEMO HERE🌟

Key Features 💡

  • Effortless Learning: Learn new words without disrupting your routine. 📚
  • Multitasking Friendly: Works perfectly while watching YouTube, writing code, or any other activity. 🎥💻
  • Multiple Backgrounds: Enjoy learning with a sleek, eye-friendly dark mode. 🌙
  • Mode Selection: Choose between displaying words in a window, in the menu bar, or enabling sound mode for auditory learning. 🔄🔊
  • Enhanced Language Selection: Select the language you want to learn and the language you are learning from. 🌐
  • Custom Dictionaries: Import custom dictionaries from text files and manage them easily within the app. 📂

Donations ❤️

If you find Vocabulary Booster helpful and would like to support its development, please consider making a donation. Your contributions will help us maintain and improve the application.

Donate with PayPal

Thank you for your support! 💖

NOTICE!

Words and translations are generated by AI, and can / should be improved in the future.

How It Works 🛠️

  1. Watching YouTube? 🎥
    • Open the app, choose your target language, and position the app window over your browser. Every 5 seconds, a new word with its translation will appear.
  2. Writing Code? 💻
    • Open the app, choose your target language, and place the app window over your coding environment. Every 5 seconds, you'll see a new word with its translation.
  3. Want to Learn by Listening? 🔊
    • Enable the "Sound" mode from the menu. The app will pronounce each new word and its translation, helping you learn through auditory reinforcement.

Getting Started for Developers 🚀

  1. Download and Install 📥

    • Clone the repository: 
      git clone https://github.com/huseyn0w/Vocabularify.git
    • Navigate to the project directory: 
      cd vocabularify

  2. Set Up Node Environment 🌐

    • Make sure you have node 18 installed and selected:

      curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
nvm install 18
nvm use 18

    • Install dependencies including Electron.js by using YARN package manager:

      yarn install
yarn start

Importing Custom Dictionaries 📂

You can import custom dictionaries through the app's "Import Dictionary" feature. Here’s how you can create and import a custom dictionary:

  1. Create a text file (.txt) with the following format: 
    word1 - translation1
word2 - translation2
...
  2. Open the app, go to the menu bar, and select "Import Dictionary".
  3. In the import window, choose the custom dictionary file, give it a name, and select the language pair it applies to.
  4. The custom dictionary will be added to the appropriate language level.

To delete a custom dictionary, select the "Delete Dictionary" option from the menu bar, choose the dictionary you want to delete, and confirm the deletion.

Enjoy boosting your vocabulary with Vocabulary Booster! 😊🎉