Skip to content

A web app that enables users to build study decks and use spaced repetition to learn content.

Notifications You must be signed in to change notification settings

LaurierCS/Mnimi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 Cannot retrieve latest commit at this time.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mnimi

Mnimi

Overview

Mnimi is a study deck web app designed to help users build and use their own decks to study and learn content. Users will have the ability to create decks of flashcards and use them to improve their studying process.

This project was built using Django and written in HTML, CSS, JavaScript, and Python. It was designed in Figma; you can view the file here.

Features

Deck Creation

Users will have the ability to build decks of flash cards, with cards able to contain both text and/or images. Users can create as many decks as they want, and can also use existing ones that other users created.

Efficient Study

Mnimi is build based on the principle of Space repetition, which describes how our brains learn more effectively when we space out our learning over time.

Users open a deck and are able to see a card with the question or diagram on the front. They can click the card to flip it and show the answer, then select how confident they were in their answer:

  1. blue = Confident/knew it,
  2. green = know it, but want to see it again
  3. red = did not know

Our Decks are designed to react to the user feedback on how well they knew the content, which will allow users to optimize their learning based on the principles of spaced repetition.

Login and Account Creation

Users login using email and password credentials to allow them to save decks, study master, and progress between sessions.

Installation

pip install pipenv

pipenv --python 3.9
pipenv shell
pipenv install -r requirements.txt

python3 manage.py runserver

Note: You'll need to drop a .env file into the Webapp directory. Contact the repository owners for access.

Acknowledgements

Many thanks to the following members of the development team:

  1. Tony Kechichian
  2. Nora Chamseddin
  3. Siddharth Khanna
  4. Duncan Spizzirri

Also, thank you to Jevin Sidhu, who was the project advisor from LCS for this project.

Remaining To-Dos

  • Add keyboard event listener to escape key to close modals
  • Improve the styling on mobile devices
  • Create “Recently Studied” component
  • Address the background z-index issues on the deck page
  • Style the card on the deck page
  • Add search functionality
  • Add forgot password functionality
  • Add sharing functionality
  • Add editing functionality
  • Improve ranking functionality

About

A web app that enables users to build study decks and use spaced repetition to learn content.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published