Skip to content

GriffinCanCode/SpellingBee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Spelling Bee App

A full-stack spelling bee application with audio input recognition.

Features

  • Audio input for spelling words
  • Speech-to-text recognition
  • Word difficulty tiers
  • Real-time feedback (correct/incorrect)
  • Free dictionary API integration
  • Local development environment

Tech Stack

Backend

  • Python 3.8+
  • FastAPI
  • SpeechRecognition library
  • Free Dictionary API

Frontend

  • Vue 3
  • TypeScript
  • Vite
  • Tailwind CSS

Project Structure

SpellingBee/
├── backend/              # Python FastAPI backend
│   ├── app/
│   ├── requirements.txt
│   └── main.py
├── frontend/             # Vue 3 + TypeScript frontend
│   ├── src/
│   ├── package.json
│   └── vite.config.ts
└── README.md

Quick Setup

For the easiest setup experience, run the automated setup script:

./setup.sh

This will automatically set up both the backend and frontend for you!

Manual Setup Instructions

Prerequisites

  • Python 3.8+: Download from python.org
  • Node.js 16+: Download from nodejs.org
  • Modern web browser: Chrome, Firefox, Safari, or Edge

Backend Setup

cd backend
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
uvicorn main:app --reload

Frontend Setup

cd frontend
npm install
npm run dev

Running the Application

  1. Start the backend (in one terminal):

    cd backend
    source venv/bin/activate
    uvicorn main:app --reload
  2. Start the frontend (in another terminal):

    cd frontend
    npm run dev
  3. Open your browser and navigate to:

How to Use

  1. Choose Difficulty: Select Easy (3-5 letters), Medium (6-8 letters), or Hard (9+ letters)
  2. Start Game: Click "Start Playing" to begin
  3. Listen to Word: Click "🔊 Hear the Word" to hear the pronunciation
  4. Record Spelling: Click the microphone button and speak each letter clearly
  5. Check Answer: Click "✅ Check Spelling" to see if you're correct
  6. Track Progress: View your score, streak, and accuracy

Features

Audio Recognition: Advanced speech-to-text processing
📊 Difficulty Levels: Three tiers of word complexity
🎯 Real-time Feedback: Instant correct/incorrect responses
📈 Progress Tracking: Score, streak, and accuracy statistics
🎵 Word Pronunciation: Built-in text-to-speech for hearing words
💾 Local Storage: Your progress is saved automatically
🆓 Completely Free: No API keys or paid services required

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors