Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 2.41 KB

README.md

File metadata and controls

70 lines (50 loc) · 2.41 KB
Raw

Spaced Repetition Study Management App

Overview

The Spaced Repetition Study Management App is designed to help users enhance their learning and memorization through the scientifically-proven spaced repetition technique. This app allows users to manage their study subjects efficiently by adding, editing, deleting, and searching subjects. It also supports data export and import for easy backup and transfer. The app features a fully responsive design for optimal use on both desktop and mobile devices.

Features

  • Add New Subjects: Easily add new study subjects with descriptions and tags.
  • Edit and Delete Subjects: Modify or remove existing subjects.
  • Search Subjects: Quickly find subjects using keywords.
  • Export and Import Data: Export subjects to a JSON file for backup or import subjects from a JSON file.
  • Progress Statistics: View total number of subjects and completed reviews.
  • Responsive Design: Seamless use on both desktop and mobile devices.

Installation

  1. Clone the repository: 
    git clone https://github.com/MohammedTsmu/Spaced-Repetition.git
  2. Navigate to the project directory: 
    cd spaced-repetition-app
  3. Open index.html in your preferred web browser.

Usage

  1. Add a New Subject:

    • Navigate to the "Add Subject" section.
    • Enter the subject name, description, and tags (comma separated).
    • Click the "Add Subject" button.

  2. Edit or Delete a Subject:

    • Navigate to the "Subjects" section.
    • Click the "Edit" button next to a subject to modify its details.
    • Click the "Delete" button to remove a subject.

  3. Search for a Subject:

    • Use the search box in the "Subjects" section to filter subjects by name, description, or tags.

  4. Export Subjects:

    • Click the "Export" button in the sidebar to download a JSON file of your subjects.

  5. Import Subjects:

    • Click the "Import" button in the sidebar and select a JSON file to import subjects.

Technologies Used

  • HTML5
  • CSS3
  • JavaScript
  • Toastify.js: For notifications
  • Google Material Icons

Project Structure

spaced-repetition-app/
├── index.html         # Main HTML file
├── style.css          # CSS styles
├── script.js          # JavaScript functionality
├── README.md          # README file
└── assets/            # Directory for additional assets (images, icons, etc.)