Skip to content

CSC510-Group18/FlashCards

 
 

Repository files navigation

Starship – Cross-shell prompt

  DOI

Description

Are you a student and having trouble preparing for tests and exams? Look no further. FlashCards also helps you memorize all that hard-to-remember information with online flashcards so that you ace your exams!

FlashCards is a spaced repetition learning platform to create, memorize and share your knowledge list using flashcards.

  1. Create folders
  2. Add decks to folder
  3. Decks in folder redirected to Practice Deck
  4. Leaderboard
  5. Quiz Mode
  6. Recently visited Decks

Watch FlashCards in Action

demo.mp4

Tech Stack

Installation

conda create -n flashcards python=3.12.2
conda activate flashcards
pip3 install .

Getting started:

Showcase

Demo Screens 1 Demo Screens 2 Demo Screens 3 Demo Screens 4 Demo Screens 5 Demo Screens 6 Demo Screens 7

Contributions to the Project

Please refer to the Contributing.md if you want to contribute to the FlashCards source code. Follow all the guidelines mentioned and raise a pull request for the developers to review before the code goes to the main source code.

Future Plans

  • Currently, a spaced repetition learning algorithm has been implemented (SM-2), but users are not able to see a schedule for when certain cards should be reviewed. We would like to add a dashboard to allow users to see statistics about when certain cards are up for review, and other statistics such as how confident they are or how often certain cards are correctly answered.
  • We have a few tests that are failing. They are primarily failing because of API endpoints that should return an error status code when given invalid data, but aren't. These would be good "first issues" to onboard new developers, and give them a good bite-sized problem to solve.
  • "Gamify" the system by adding rewards, an XP based progression system, and streaks for consistently completing the aforementioned spaced repetition for consecutive days in a row.

Help

Email any queries to the contributors

Authors

  1. Akhil Chawla

  2. Sanjana Dalal

  3. Priya Gandhi

  4. Akhil Chawla

  5. Sanjana Dalal

  6. Priya Gandhi

  7. Jeff Powell

  8. Zeiad Yakout

  9. Jakub Jon

License

MIT

Funding

Our project at the moment is not funded by any organization/individual.

About

A spaced repetition learning platform to create, memorize and share your knowledge list using flashcards.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Python 38.3%
  • TypeScript 33.6%
  • HTML 16.7%
  • SCSS 8.4%
  • CSS 2.1%
  • JavaScript 0.4%
  • Other 0.5%