Skip to content

The Wrong-Question Notebook (WQN) is a web-based application designed to help students systematically track, organise, and revise the problems they answered incorrectly.

License

Notifications You must be signed in to change notification settings

mrmagic2020/Wrong-Question-Notebook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wrong Question Notebook

The Wrong Question Notebook (WQN) is a web-based application designed to help students systematically track, organize, and revise the problems they answered incorrectly. It provides a comprehensive system for managing problems across multiple subjects, tracking progress, and facilitating effective revision through structured practice sessions.

🚀 Features

Core Functionality

Subject Management

  • Create, edit, and delete subjects to organize your problems
  • Subject-based navigation and filtering
  • Clean, intuitive subject management interface
  • Track problem counts and activity per subject

Problem Management

  • Three Problem Types: Multiple Choice Questions (MCQ), Short Answer, and Extended Response
  • Rich Content Support: Create problems with formatted content using an advanced rich text editor
    • Text formatting (bold, italic, underline, headings)
    • Mathematical equations with LaTeX support
    • Tables and lists
    • Links, subscript, and superscript
    • Image embedding with resizable images
    • Typography enhancements
  • Status Tracking: Mark problems as Wrong, Needs Review, or Mastered
  • Auto-marking: Enable automatic answer validation for multiple choice questions
  • Assets Management: Attach images and PDF files to problems
  • Solution Support: Add detailed solutions with text and assets

Tag System

  • Create and manage tags within subjects for better organization
  • Tag problems with multiple tags for flexible categorization
  • Filter problems by tags
  • Global tag overview across all subjects
  • Tag-based problem discovery

Problem Sets

  • Create custom problem sets from your problems
  • Sharing Levels: Private, Limited (share with specific users via email), or Public (all registered users)
  • Add and remove problems from sets
  • Track progress within problem sets
  • Problem set review mode for structured practice

Interactive Review System

  • Submit answers to problems with appropriate input types:
    • Text input for short answers
    • Textarea for extended responses
    • Multiple choice selection for MCQ
  • Automatic Validation: Auto-marked problems are validated instantly
  • Manual Review: Self-assessment workflow for complex problems
  • Solution Reveal: View detailed solutions after attempting problems
  • Status Updates: Update problem status during review
  • Track attempt history and review dates

AI Features

  • TODO

🛠️ Tech Stack

  • Frontend: Next.js 15, React 18, TypeScript
  • Styling: Tailwind CSS, shadcn/ui components, Radix UI
  • Rich Text Editor: TipTap with extensions (Mathematics, Tables, Links, Images)
  • Database: Supabase (PostgreSQL)
  • Authentication: Supabase Auth
  • Storage: Supabase Storage for file uploads
  • Deployment: Vercel
  • Validation: Zod for schema validation
  • Math Rendering: KaTeX for LaTeX equations
  • Analytics: Vercel Analytics and Speed Insights
  • Code Quality: ESLint, Prettier, TypeScript

📦 Installation & Setup

  1. Clone the repository
  2. Navigate to the web directory: cd web
  3. Install dependencies: npm install
  4. Set up environment variables (see env.example)
  5. Run the development server: npm run dev

For detailed deployment instructions, see DEPLOYMENT.md.

📄 Documentation

  • CHANGELOG.md: Track all notable changes and version history
  • DEPLOYMENT.md: Comprehensive deployment guide for Vercel
  • Proposal.md: Initial project proposal and requirements

🤝 Contributing

This project uses:

  • ESLint and Prettier for code formatting
  • TypeScript for type safety

Run npm run check-all to validate your changes before committing.

📝 License

This project is licensed under the GPL-3.0 license. See LICENSE for details.

About

The Wrong-Question Notebook (WQN) is a web-based application designed to help students systematically track, organise, and revise the problems they answered incorrectly.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 5

Languages