redwolf2467/edugrade repository overview

⁠EduGrade

A secure web application for teachers to manage student grades, classes, and performance tracking. Built with Python (Quart) and JavaScript.

⁠Features

• Class & Student Management - Create classes, add students, track individual performance
• Subject-Based Organization - Divide classes into multiple subjects (default subject can be renamed, e.g., "Math")
• Grade Tracking - Record grades with customizable categories, weights, and percentage-based +/~/- systems
• Student Import - Import student lists via CSV or JSON for quick class setup
• Analytics & Charts - Visual charts and detailed statistics for student performance
• PDF Export - Download and print detailed student views with grades and charts
• Grade Sharing with Students - Securely share grades with students using PIN-protected access links with expiration dates
• Customizable Categories - Define grade categories with custom weights and names
• Plus/Minus Grade System - Configurable percentage-based grading system with plus, neutral, and minus values
• Participation Tracking - Track and record student participation grades
• Grade Percentage Ranges - Customizable percentage-to-grade mapping
• Data Export/Import - Backup and restore data in JSON format
• Dark/Light Mode - Comfortable viewing in any environment
• Responsive Design - Works on desktop, tablet, and mobile
• Tutorial System - Guided onboarding for new users

⁠Security

• AES-256-GCM Encryption - All user data encrypted at rest with password-derived keys
• Encrypted Grade Shares - Shared grade data is encrypted using a master key
• PBKDF2 Key Derivation - 200k iterations for password hashing, 100k for encryption keys
• 1-Hour Sessions - Short-lived sessions with automatic cleanup
• Zero-Knowledge - Server admins cannot read user data without the password
• PIN-Protected Access - Student grade access secured with 6-digit PINs
• Smart Caching - In-memory cache with heartbeat system for performance
• Automatic Share Cleanup - Expired and revoked shares are automatically removed

⁠Tech Stack

⁠Quick Start

⁠🐳 Docker (Recommended)

The easiest way to run EduGrade:

# Pull the latest image
docker pull redwolf2467/edugrade

# Run container (accessible at http://localhost:8080)
docker run -d \
  --name edugrade \
  -p 8080:1601 \
  -v edugrade-data:/app/data \
  --restart unless-stopped \
  redwolf2467/edugrade:latest

Done! Open http://localhost:8080 in your browser.

⁠Docker Compose

# Download docker-compose.yml
curl -O https://raw.githubusercontent.com/rwolf2467/EduGrade/main/docker-compose.yml

# Edit ports if needed (default: 1601:1601, change to 8080:1601 for external port 8080)
nano docker-compose.yml

# Start
docker-compose up -d

See DOCKER.md⁠ for more Docker options and production setup.

⁠🐍 Manual Installation

# Clone and install
git clone https://github.com/rwolf2467/edugrade.git
cd edugrade
pip install -r requirements.txt

# Run
python app.py

Open http://localhost:1601 in your browser.

⁠Virtual Environment (Recommended)

python -m venv venv
source venv/bin/activate  # Linux/Mac
venv\Scripts\activate     # Windows
pip install -r requirements.txt

⁠Project Structure

edugrade/
├── app.py              # Main application, routes, auth, encryption
├── requirements.txt    # Python dependencies
├── static/
│   ├── css/            # Styles
│   ├── i18n/           # Internationalization files
│   ├── logo.svg        # Logo files
│   └── scripts/        # JavaScript modules
├── templates/
│   ├── index.html      # Main dashboard
│   ├── login.html      # Authentication page
│   └── student_grades.html # Student grade view
└── data/
    └── edugrade.json   # Encrypted user data (auto-created)

⁠Configuration

Edit app.py to customize:

For production, change app.secret_key to a secure random string.

⁠Production Deployment

1. Set debug=False in app.run()
2. Use HTTPS via reverse proxy (Nginx/Apache)
3. Set secure=True for cookies
4. Configure proper environment variables
5. Set up logging and monitoring

⁠Student Access & Sharing

Teachers can create secure grade shares for students:

1. Select a class and subject to share
2. Set expiration time (1 hour to 30 days)
3. Configure visibility options (grades, averages, final grades, charts, etc.)
4. Generate unique PINs for each student (6-digit)
5. Students access their grades using the share link and their personal PIN

Students can view:

• Individual grades with color-coded badges
• Category breakdowns
• Class averages
• Performance charts
• Subject information
• Teacher name

⁠Detailed Student View

Click on any student to view:

• Complete grade history with charts
• Category-wise performance breakdown
• Statistical analysis and trends
• Export to PDF for printing or archiving
• Visual performance indicators

⁠License

EduGrade - Copyright (C) 2026 Fabian Murauer

Licensed under the GNU Affero General Public License v3.0⁠.

• Use, study, modify, and share freely
• Modified versions must provide source code
• Credit the original author
• Cannot be made proprietary

⁠Security Reporting

Report vulnerabilities via GitHub Issues⁠.