dionne-stratton / frontend-react-desktop

Rabbi-Rabbit

An app designed to supplement Hebrew language learning by providing a simple yet engaging way to review Hebrew vocabulary.

The purpose of this app is to help those learning the Hebrew language. It uses direct input for review questions and impliments spaced repitition.

View the live website here: Rabbi-Rabbit

Quicklinks

• Related Repos
• Tech Stack
• Useful Resources
• Project MVP Features
  • Authorization
  • Dashboard
  • Lessons
  • Reviews
  • Vocabulary
  • Account Settings
  • Danger Zone
• Features for Future Release
  • Audio Clips
  • Monthly Subscription

Related Repos

Native Mobile App

Desktop Web App

Mongo Database and Server

Tech Stack

• React

• Javascript

• CSS

• Validation with Yup

• Tests with react testing library (comming soon)

Useful resources

Contribution Guidelines

About Markdown

MongoDB Course

React Native Docs

React Tutorial

Project MVP Features

A list of the features needed for a minimum viable product across the enitre project: desktop frontend, mobile native frontend, and the backend server.

Authorization

• Auth functionality
  • Sign up:
    • On first signup, a new user is crated with a level of 1, the first set of lessons, and email and hashed password
  • Sign in:
    • On sucessful signup / signin redirects to dashboard and changes nav items
  • Sign out:
    • Signing out redirects to main landing page, changing nav items.
  • Password reset:
    • If a user has forgotten their password, they can click the reset password button. This will send a request to the server which will send an email to the user with a pin needed to reset the password. If the correct pin, email, and password are provided, the password is reset and the user is redirected to login.

Dashboard

• Lessons button with count
• Reviews button with count
• Displays next available review date and time
• Mastery progress bar for current level

Lessons

• Lessons display Hebrew, Hebrew with Nikkud, pronounciation guide, and meaining. They may be a single word or a phrase.
• Viewing lessons adds them to the reviews array with a level of 1 "New" and are immediately avaiable for review
• Forward and backward navigation of lessons
• New lessons are unlocked when the current set has 80% of items at master rank 3 or higher
• New lessons are added to any existing lessons list

Reviews

• Randomized available reviews
• Direct input for answering questions
• Hebrew "keyboard" for inputing reading
• Detects language, enforces correct language
• Provides feedback on correct or incorrect answer given and shows correct answer
• User must provide correct meaning and reading for each vocab item for it to rank up
• If any item is answered incorrectly, it is ranked down unless it is at the bottom rank already
• When an item has been reviewed, it is assigned a next review date using a spaced repitition formula depending on the new rank of the item
• Going through all reviews or clicking the dashboard button submits answered vocab items

Vocabulary

• Vocab viewed by level
• Displays only vocab unklocked / reviewed by user
• Displays Hebrew, with nikkud, meaining, pronunciation, level, and mastery rank

Account Settings

• Checkbox to display nikkud on reviews
• Checkbox for displaying pronunciation on reviews
• Settings are saved to local storage

Danger Zone

• Reset Learning Progress
• Delete Account

Features for future release

A list of the features planned for future release across the enitre project: desktop frontend, mobile native frontend, and the backend server.

Audio Clips

• Listen to the vocab spoken by a native speaker.

Monthly Subscription

• Charge a monthly fee for access to app beyond the first three levels.

If you have ideas for more featues please reach out!