Skip to content

FlashCardMasher is learning tool that transforms any text, PDF, or web content (not yet though) into interactive flashcards within seconds. Powered by LLM.

License

Notifications You must be signed in to change notification settings

mahiatlinux/FlashCardMasher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FlashCardMasher 🧠📑

image

image

image

Overview

FlashCard Masher is an AI-powered flashcard generation application designed to transform your study materials into interactive learning tools. Built with React, this application leverages advanced AI technology to help students and learners create, manage, and study flashcards effortlessly.

🚀 Features

  • AI-Powered Flashcard Generation

    • Extract key concepts from text, PDFs, DOCX files, and URLs
    • Customize flashcard difficulty and format
    • Generate up to 50 flashcards in seconds
  • Comprehensive Deck Management

    • Create, edit, and delete flashcard decks
    • Tag and categorize your decks
    • Intuitive dashboard for tracking your learning
  • Smart Study Mode

    • Spaced repetition learning
    • Confidence-based card tracking
    • Detailed study session analytics
  • Multi-Format Input

    • Paste text directly
    • Upload PDFs and Word documents
    • Import content from web URLs (NOT WORKING AS OF NOW)

🛠 Tech Stack

  • Frontend: React, Tailwind CSS
  • Backend: Express.js
  • AI Integration: OpenAI Compatible API
  • State Management: Custom React stores
  • Routing: React Router
  • File Handling: Multer, PDF-parse, Mammoth.js

🔧 Prerequisites

  • Node.js (v16+)
  • npm or Yarn
  • API Key for OpenAI compatible API

🏃‍♂️ Getting Started

Installation

  1. Clone the repository

    git clone https://github.com/mahiatlinux/FlashCardMasher.git
    cd FlashCardMasher
  2. Set up environment variables by renaming .env.example to .env and changing the credentials if needed.

  3. Get it ready

    python3 setup.py

    This will install the node modules.

Running the Application

  1. Start the whole app

    python3 run.py
  2. Open http://localhost:5000 in your browser

🌟 Created By

Maheswar

  • Innovative 15 year old developer passionate about learning technology
  • Built FlashCardMasher to make studying more efficient and engaging

Check out my website: https://masherai.yxz HuggingFace profile: https://huggingface.co/mahiatlinux

📄 License

This project is open-source and licensed under MIT. See the LICENSE file for details.

🤝 Contributing

Contributions are welcome!!! Please!

🐛 Issues

Found a bug? Please file an issue.

Future Roadmap

  • Some UI problems
  • Multi-language support
  • Advanced analytics dashboard
  • Cloud sync and backup
  • Mobile app version
  • Improve animations
  • Scrape URLs

Happy Studying! 📚✨

About

FlashCardMasher is learning tool that transforms any text, PDF, or web content (not yet though) into interactive flashcards within seconds. Powered by LLM.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published