Skip to content

GOMAN-AI/wordpan-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 

Repository files navigation

GOMAN.AI - Language Learning Application

A flashcard-based language learning application, featuring audio interactions, AI-powered word suggestions, and spaced repetition.

Tech Stack

Frontend

  • React - UI framework
  • React Router - Client-side routing
  • ShadCN - UI component library

Backend

  • Supabase - Database, authentication, and real-time subscriptions
  • Supabase Edge Functions - Serverless functions for business logic

AI & Services

  • CrewAI - AI orchestration framework (using Grok as provider)
  • GROQ - Audio pronunciation and LLMs (using free tier)
  • Microservice with AI Agent - Separate service for meeting recording analysis and word processing

Features

Phase 1: Core Features

1. User Authentication

  • Email-based sign up and login (via Supabase Auth)
  • User profile management
  • Secure session handling

2. Language Pair Selection

  • Native Language: English
  • Target Language: Polish

3. Word Pairs Management

  • Add word pairs to personal dictionary (source word + translation)
  • AI-powered translation suggestions (using CrewAI)
  • Remove word pairs from dictionary
  • Mark word pairs as "mastered"
  • View word history and statistics

4. Flashcard System

  • Text display of word and translation
  • User interaction: "Correct" / "Incorrect" buttons
  • Track correct/incorrect counts per word pair
  • Progress visualization

5. Daily Assignments

  • Configurable daily word quota
  • Adjustable difficulty (number of repetitions required)
  • Daily streak tracking

6. Gamification & Motivation

  • Scoring System
    • Points earned for completing flashcard sets
    • Bonus points for completing daily vision/goals
    • Points for consecutive correct answers
    • Streak multipliers for consistent practice
  • Dashboard
    • Current streak count (days)
    • Longest streak record
    • Total points/score
    • Daily progress bar toward goal
    • Weekly/monthly statistics
    • Calendar view with activity heatmap
  • Achievements & Milestones
    • Badges for streak milestones (7, 30, 100 days)
    • Completion badges (total words mastered)
    • Perfect day badges (100% daily goal completion)
  • Progress Visualization
    • XP/level system based on total points
    • Visual feedback for completing sets
    • Celebration animations for milestones

Phase 2: Advanced Features

7. Spaced Repetition Algorithm

  • Implement SRS (Spaced Repetition System)
  • Automatically adjust review intervals based on performance
  • Prioritize words that need more practice

8. Word Frequency Suggestions

  • Suggest words based on usage frequency in language
  • Use common word frequency dictionaries
  • Filter by difficulty level (beginner/intermediate/advanced)

9. User Onboarding & Level Assessment

  • Initial assessment quiz to determine user level
  • Set learning goals and targets
  • Customize daily practice settings

10. Meeting Recording Analysis (Microservice)

  • Upload audio recordings of tutoring sessions
  • Transcribe and analyze conversations
  • Extract frequently used words
  • Suggest words to add to practice list

11. Voice Agent Interaction

  • Practice pronunciation with voice input
  • Speech-to-text validation
  • Feedback on pronunciation accuracy
  • (Future phase - not priority)

Roadmap

Phase 0: MVP (Minimum Viable Product)

  • User authentication (email signup/login)
  • Basic word pairs management (add, remove, list)
  • AI-powered translation suggestions (CrewAI + Grok)
  • Flashcard system with text only
  • Correct/Incorrect tracking per word pair

Phase 1: Core Features

  • Daily assignment tracking
  • Basic statistics dashboard
  • User onboarding flow
  • Daily streak tracking
  • Gamification system (scoring, streaks, achievements)
  • Dashboard with progress visualization and calendar heatmap

Phase 2: Advanced Learning Features

  • Spaced repetition algorithm (SRS)
  • Audio pronunciation (GROQ integration)
  • Word frequency suggestions
  • Level assessment

Future Considerations

  • Word extraction from recordings
  • Voice agent interaction
  • Multiple language pairs
  • Social features (word sharing, leaderboards)
  • User feedback and reporting system

About

Specification for the project we will be doing during workshop

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published