Skip to content

Mateo610/StudyTool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

AI Study Assistant

An AI-powered study assistant that converts student notes into summaries, flashcards, and multiplayer quiz games using AWS services.

Tech Stack

  • Frontend: React + Vite + Tailwind CSS
  • Backend: AWS Lambda + API Gateway + DynamoDB
  • AI: AWS Bedrock (Claude)
  • Voice: Alexa Skills Kit (Phase 4)
  • Deployment: Serverless Framework

Project Structure

├── backend/                 # AWS Lambda functions
│   ├── functions/          # Lambda handlers
│   ├── services/           # Business logic services
│   └── serverless.yml      # Infrastructure definition
├── frontend/               # React application
│   ├── src/
│   │   ├── components/     # Reusable UI components
│   │   ├── pages/          # Page components
│   │   └── services/       # API client
│   └── package.json
└── alexa-skill/            # Alexa integration (Phase 4)

Phase 1: Core Infrastructure ✅

Status: Complete

Backend Setup

  1. Install dependencies:

    cd backend
    npm install
  2. Deploy to AWS:

    npm run deploy
  3. Run locally (for development):

    npm run offline

Frontend Setup

  1. Install dependencies:

    cd frontend
    npm install
  2. Create environment file:

    echo "VITE_API_URL=http://localhost:3001/dev" > .env
  3. Start development server:

    npm run dev

Features Implemented

Phase 1 Features ✅

  • File upload and text extraction
  • AI content generation (summaries, flashcards, quiz questions)
  • Beautiful study interface with tabs
  • Interactive flashcard viewer
  • Responsive design with Tailwind CSS
  • Error handling and loading states

Phase 2 Features (Next)

  • Enhanced file uploader with drag-drop
  • Study set management
  • File upload handler with text extraction

Phase 3 Features (Future)

  • Multiplayer quiz sessions
  • Real-time quiz gameplay
  • Leaderboards and scoring
  • Room code system

Phase 4 Features (Future)

  • Alexa skill integration
  • Voice quiz capability

API Endpoints

  • POST /upload - Upload file and extract text
  • POST /generate - Generate AI study content
  • POST /session - Create quiz session
  • POST /session/join - Join session by room code
  • GET /session/{id} - Get session details
  • POST /session/{id}/answer - Submit answer
  • POST /session/{id}/next - Advance to next question
  • GET /session/{id}/scores - Get leaderboard

Environment Variables

Backend

  • AWS_REGION - AWS region (default: us-east-1)
  • BEDROCK_MODEL_ID - Bedrock model ID
  • DYNAMODB_TABLE - DynamoDB table name

Frontend

  • VITE_API_URL - Backend API URL

Development Workflow

  1. Start backend locally: cd backend && npm run offline
  2. Start frontend: cd frontend && npm run dev
  3. Test the flow: Upload notes → Generate content → View results

Next Steps

  1. Phase 2: Enhance the study interface
  2. Phase 3: Build multiplayer quiz functionality
  3. Phase 4: Add Alexa integration

Demo Script

  1. Upload a text file or paste notes
  2. Watch AI generate summaries, flashcards, and quiz questions
  3. Navigate through flashcards with smooth animations
  4. View quiz questions with correct answers highlighted

Total demo time: ~2 minutes

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages