Documentation

Complete guide to the Regis University Data Science Practicum Portfolio System

System Overview

The Regis Portfolio Editor is a modern web-based system for managing student practicum portfolios (MSDS 692/696). Students login via GitHub OAuth and use an intuitive 26+ field form editor to create professional portfolios. The system features real-time validation, image cropping, automatic GitHub integration, and instant deployment.

🎓 For Students

  • • Login with GitHub OAuth - secure and simple
  • • Use web-based form editor - no coding required
  • • Upload files with built-in image cropper
  • • Real-time preview and validation
  • • Portfolios instantly deployed to regisportfolio.com

👩‍🏫 For Instructors

  • • Add students to encrypted database
  • • Students create portfolios independently
  • • Manage spotlight projects for exceptional work

Web Editor System

🚀 Modern Form-Based Editor

The web editor provides an intuitive interface where students fill out a comprehensive form (26+ fields) to create their portfolios. No coding, markdown, or technical knowledge required - just login with GitHub and start creating!

🔐

GitHub OAuth

Secure authentication via GitHub accounts

📝

Form Editor

26+ fields with real-time validation

Auto-Deploy

Instant deployment to live website

Key Features:

  • Image Cropper: Built-in tool for perfect avatar sizing
  • Skills Autocomplete: Suggestions for common tech skills
  • Form Validation: Real-time error checking
  • File Preview: See uploads before committing

Authentication & Security

GitHub OAuth 2.0 Authentication

Students authenticate using their GitHub accounts via industry-standard OAuth 2.0. The system validates against an encrypted student database and creates secure sessions. All student data is protected with AES-256 encryption for maximum security.

Security Features

  • AES-256 Encryption: Military-grade encryption for student database
  • GitHub Secrets: OAuth credentials stored in secure environment
  • Email Validation: @regis.edu domain requirement for access
  • Session Management: Encrypted sessions with timeout protection

Student Privacy

  • Full Control: Students maintain complete control of their data
  • No Data Retention: Editor doesn't store portfolio content separately
  • GitHub Transparency: All changes visible in commit history
  • FERPA Compliant: Educational records protected per federal law

Data Security Assurance

All student portfolio data is encrypted at rest and in transit. The system complies with FERPA regulations and institutional privacy policies. Students can request data deletion at any time through account settings.

Student Guide

Quick Start Process

  1. 1. Login at editor.regisportfolio.com with GitHub
  2. 2. Fill out the 26+ field form with your information
  3. 3. Upload avatar, reports, and presentations
  4. 4. Preview and save - portfolio deploys instantly

Editor Sections

  • Personal Info: Name, email, contact details
  • Skills: Technologies with autocomplete
  • Projects: MSDS 692/696 practicum details
  • Files: Avatar, CV, reports, presentations

Instructor Guide

Semester Setup

  1. 1. Add students to encrypted database
  2. 2. Students use web editor to create portfolios
  3. 3. System auto-deploys to regisportfolio.com
  4. 4. Manage spotlight projects manually via JSON

Key Features

  • • One-click student portfolio generation
  • • Automated folder structure creation
  • • Spotlight project management
  • • Multi-semester support

Key Features

Responsive Design

Professional portfolios that work on all devices

Automated Workflow

Form submission to live portfolio in seconds

University Branding

Consistent Regis University visual identity

Additional Resources

LaTeX Report Template

Professional template for MSDS 692/696 practicum reports

Access Template

Example Portfolios

Browse real student portfolios for inspiration and best practices

View Student Portfolios