Skip to main content

Piglet Prep

Story comprehension made fun

Piglet Prep

Report Issue on Jira Deploy Docs Documentation Website Link

Smart Pig GIF

Hammy the Pig

Project Abstract

This website is a child-friendly video platform designed to offer interactive educational content. Videos are enhanced with embedded Multiple Choice Questions (MCQs) and Object Detection (OD) questions to engage children and assess their understanding as they watch. The system allows users to answer MCQs and OD questions based on each video real-time, customize their preference for each video, and allows researchers to review performance analytics.

Piglet Prep on Web Browser

You can access the deployed site here.

Running Piglet Prep Locally

  1. Create a S3 bucket
  2. Download the following video as .mp4 and add to S3 buckets with the following filenames:
  3. Acquire API keys for:
  • OpenAI (for ChatGPT)
  • AWS (one for Rekognition and another for S3 access)
  • MongoDB (for storing metrics)
  1. Create a .env.local file at project-piggyback-learning-team-1/pigletprep and add the following variables and match it with your API keys you created at the // mark:
AWS_ACCESS_KEY_ID=//S3 API KEY
AWS_SECRET_ACCESS_KEY=//S3 SECRET API KEY
AWS_REGION=//AWS REGION
AWS_REGION_NAME=//AWS REGION
S3_BUCKET_NAME=//S3 BUCKET NAME
OPENAI_API_KEY=//OPENAI API KEY
MONGODB_URI=//MONGODB API KEY
secretAccessKey=//AWS REKOG. SECRET KEY
accessKeyId=//AWS REKOG. API KEY
NEXT_PUBLIC_METRICS_PAGE_KEY=//CREATE A PIN FOR METRICS
  1. Run the following commands in your terminal:
cd pigletprep
npm install
npm run build
npm start

NOTE: To ensure video plays on video page, check to see if you have "Use graphics acceleration when available" enabled on browser.

NOTE: Also in ".env.local" file, ensure there is no space between the "=" and your API keys.

Collaborators

Hxrob
Hirab Abdourazak
noel-chacko
Noel Chacko
Henry2809
Henry Nguyen
adrewtran117
Andrew Tran
sophiechen18
Sophie Chen
ewongzz
Ernest Wong