Mnemoniac Frontend

A flashcard application built with React.

Features

Core Features (To be implemented)

• Deck Management

  • Create, edit, and delete custom flashcard decks
  • Import/export decks in common formats (CSV, JSON)
  • Organize decks with tags and categories

• Flashcard Creation

  • Add cards with front (question) and back (answer) sides
  • Support for rich text formatting
  • Ability to include images and code snippets
  • Bulk card creation from text or spreadsheet

• Study System

  • Spaced repetition algorithm for optimal learning
  • Multiple study modes (classic, quiz, timed review)
  • Progress tracking and performance analytics
  • Custom study schedules

Technologies Used

• React
• TypeScript (inferred from vite.config.ts and package.json)
• Vite
• Vitest
• ESLint (configured in package.json)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js and npm installed.

Installation

1. Clone the repository:

   git clone [this repository URL]

2. Navigate to the project directory:

   cd flashcard-app-frontend

3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

Usage

[Instructions on how to use the app. This will require examining the application code itself to determine how to use the application].

Testing

The project uses Vitest for testing. To run tests:

npm run test

Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests.

License

This project is licensed under the MIT License.