How meephubub/flashcards works
Project type and purpose
• This is a full-stack flashcards application built on Next.js 13’s App Router.
• It combines a React-based front-end (UI pages and components) with serverless API routes for data storage, AI-powered features (question generation, grading, similarity), and a Supabase backend.
Main components
a. Front-end (Browser/Client)
• Next.js pages in app/…/page.tsx
• React components (e.g., card-display, deck-grid, ai-chat, sidebar)
• Context providers (deck-context, settings-context) and custom hooks
b. Next.js Server / API Layer (Serverless Functions)
• API routes under app/api/…/route.ts (decks, cards, progress, settings, import, generate, chat, upload)
• Action handlers under app/actions/… (ai-chat, generate-questions, grade-answer, xenova-similarity)
c. Database
• Supabase (PostgreSQL) accessed via lib/supabase.ts and the SQL schema in lib/supabase-schema.sql
d. Machine Learning & External AI Services
• Local ONNX model loaded via Xenova in public/models and invoked in xenova-similarity
• (Optionally) OpenAI API keys configured in lib/api-keys.ts for AI chat and note generation
e. Static Assets & Other Services
• Static files in public/ (models, sounds)
• File uploads (handled by app/api/upload/route.ts)
Relationships & Data Flows
• Browser → Next.js Server: Request pages / invoke server components
• Browser → API Layer: Fetch deck/card data, post progress, trigger AI features
• API Layer → Supabase: CRUD operations on decks, cards, progress, settings
• API Layer → ML/AI Services:
• Local ONNX model for semantic similarity
• External AI (OpenAI) for chat, question/note generation
• API Layer → File Storage (public/uploads) for any assets
Architectural patterns & design principles
• Separation of Concerns:
• UI (components + pages) vs. business logic (actions) vs. data (API routes)
• Serverless Micro-Endpoints: each app/api/.../route.ts is an isolated function
• React Server Components & Client Components under Next.js App Router
• Context & Hooks for state management (deck-context, settings-context, custom hooks)
• Typed contracts with TypeScript (shared types in types/)
Technologies & Frameworks
• Next.js 13 App Router (React, Server & Client components)
• Tailwind CSS for styling (styles/ + tailwind.config.ts)
• Supabase for database & auth (lib/supabase.ts)
• ONNX/Xenova for on-device model inference (public/models/...)
• OpenAI or other LLMs via API (keys in lib/api-keys.ts)
• PNPM workspace, PostCSS, TypeScript
Essential elements
• Clear component boundaries (frontend vs backend)
• Labels for technologies (Next.js, Supabase, Xenova, OpenAI)