Skip to content

LouisThmas/knowledge-trove

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knowledge Trove

Knowledge Trove Logo

Overview

Knowledge Trove is an AI-powered assignment grading platform designed to help students who struggle to stay focused and motivated. By providing instant feedback and gamified rewards, it transforms the learning experience into an engaging journey.

How It Helps Students

Students who struggle with focus often need:

  • Immediate feedback to stay engaged
  • Clear goals to work toward
  • Tangible rewards for their efforts
  • Structured guidance without overwhelming complexity

Knowledge Trove addresses these needs by:

  1. AI-Powered Instant Grading - Get immediate feedback on your work using Google Gemini AI
  2. Real-Time Evaluation - Upload criteria/rubric and receive grades (0-100) with constructive feedback
  3. Physical Rewards - Earn access to a "treasure chest" (via Bluetooth-connected servo) when you score above 50%
  4. Progress Tracking - Save multiple assignments and track your improvement over time
  5. Focused Environment - Clean, distraction-free interface designed for concentration

Features

  • Document Management - Create, save, and organize multiple assignments
  • DOCX Criteria Upload - Upload rubrics/criteria in DOCX format for AI evaluation
  • AI Grader Chat - Interactive chat interface for personalized feedback
  • Bluetooth Integration - Physical reward system using Arduino-controlled servo
  • User Authentication - Secure JWT-based login system
  • Auto-Save - Never lose your work with automatic document saving

Technologies Used

Frontend

  • React 19 with TypeScript
  • Vite - Fast build tool and dev server
  • TailwindCSS - Utility-first styling
  • React Router - Client-side routing
  • Mammoth.js - DOCX file parsing
  • Web Bluetooth API - Arduino communication
  • React Icons - Modern icon library

Backend

  • Flask - Python web framework
  • MongoDB Atlas - Cloud database
  • Google Gemini AI - AI-powered evaluation
  • PyJWT - Token-based authentication
  • Flask-CORS - Cross-origin resource sharing

Hardware

  • Arduino 101 - Bluetooth-enabled microcontroller
  • Servo Motor - Physical reward mechanism

Installation

Prerequisites

  • Node.js (v16+)
  • Python 3.10 (Required for compatibility with cryptographic modules)
  • MongoDB Atlas account
  • Google Gemini API key
  • Arduino 101 (optional, for treasure chest feature)

Backend Setup

  1. Create Python 3.10 virtual environment:

    cd server
    py -3.10 -m venv venv

    Important: Must use Python 3.10 due to Windows compatibility issues with Python 3.11+ and the cryptographic module for Gemini.

  2. Activate virtual environment:

    # Windows
    venv\Scripts\activate
    
    # macOS/Linux
    source venv/bin/activate
  3. Install dependencies:

    pip install -r requirements.txt
  4. Create .env file:

    MONGO_DB_STRING=your_mongodb_connection_string
    SECRET_KEY=your_secret_key
    GEMINI_API_KEY=your_gemini_api_key
  5. Run Flask server:

    flask run

Frontend Setup

  1. Install dependencies:

    cd client
    npm install
  2. Create .env file:

    VITE_API_URL=http://localhost:5000
  3. Run development server:

    npm run dev

Arduino Setup (Optional)

  1. Upload the Bluetooth servo code to your Arduino 101
  2. Use the UUIDs from client/src/utils/arduinoConnect.tsx
  3. Click "Connect Treasure" in the app to pair
  4. Score above 50% to trigger the servo!

Usage

  1. Sign Up/Sign In - Create an account or log in
  2. Create Assignment - Click "New Assignment" to start
  3. Upload Criteria - Upload a DOCX file with grading criteria (optional)
  4. Write Content - Write your assignment in the editor
  5. Get AI Feedback - Click "Evaluate" for instant grading and feedback
  6. Unlock Treasure - Score 75%+ to trigger the physical reward!

Perfect For

  • Students with ADHD or focus challenges
  • Self-paced learners who need immediate feedback
  • Visual/kinesthetic learners who benefit from tangible rewards
  • Anyone who wants to gamify their study routine

License

This project is licensed under the MIT License.

About

Application where if the user writes enough of their assignment and the AI judges it ≥90% compliant, the physical treasure box lights up and unlocks.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors