Skip to content

Latest commit

 

History

History
117 lines (76 loc) · 2.97 KB

README.md

File metadata and controls

117 lines (76 loc) · 2.97 KB

WORDG

WORDG is application helping users learn foreign language words. The words and answers are read from a text file.

Table of Contents

Features

  • Load words from a text file for the quiz
  • Interactive quiz to test your knowledge
  • Feedback on correct and incorrect guesses

Screens

Open File Screen

OpenTranslation

This screen allows the user to open and load the text file containing the words for the quiz.

  • Open button for opening from file system
  • Open recent for opening recent file

Translation Quiz Screen

TranslateWord

This screen presents the user with a word in their native language and asks for the translation in the foreign language.

  • Red cross for closing quiz
  • Progress of a quiz "answered/all"
  • Check button for checking answer

Correct Answer Screen

CorrectAnswer

If the user guesses the translation correctly, this screen provides positive feedback and presents the next word.

Incorrect Answer Screen

IncorrectAnswer

If the user guesses the translation incorrectly, this screen provides corrective feedback and presents the correct translation.

Exit Confirmation Screen

QuitConfirmation

This screen asks the user if they want to close quiz.

Quiz Completion Screen

Congratulations

When the user completes the quiz, this screen is shown.

File Format

The text file have the following format:

kuchnia - kitchen
jedzenie - food
...

Getting Started

Prerequisites

  • Make sure you have NPM installed on your system.

Installation

  1. Clone the repository:
    git clone https://github.com/liscju/wordg
  2. Navigate to the project directory:
    cd wordg

Usage

  1. Run the application:
    npm start
  2. Follow the on-screen instructions to load the word file and start the quiz.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for review.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project uses open source Koulen font and free icons from icons8.