Instructor Guide

Complete guide for managing the Regis University Portfolio system

Overview

The Regis Portfolio Editor provides a modern, web-based system for managing student practicum portfolios. Students login via GitHub OAuth and use an intuitive form editor (26+ fields) to create their portfolios - no coding required. The system automatically commits changes to GitHub and generates professional HTML portfolios.

Supports both MSDS 692 (Practicum I) and MSDS 696 (Practicum II) courses with GitHub OAuth authentication, real-time validation, and automated deployment.

Semester Setup Workflow

The new web editor system simplifies student portfolio management. Students access the editor at editor.regisportfolio.com, login with GitHub, and create their portfolios through an intuitive form interface.

1. Add Students

Add student records to the encrypted students.json database for authentication

2. Students Create

Students login and fill out the web editor form to create their portfolios

3. Auto-Deploy

Portfolios automatically deploy to regisportfolio.com when students save

Web-Based Portfolio Editor

Students access a professional web editor with GitHub OAuth authentication. The system provides 26+ form fields, real-time validation, image cropping, and automatic GitHub integration.

Key Features for Students

  • GitHub OAuth: Secure login via GitHub account
  • 26+ Form Fields: Comprehensive profile builder
  • Rich Text Editor: Format content without coding
  • Image Cropper: Perfect avatar sizing tool

Instructor Benefits

  • Encrypted Database: Student data securely stored
  • GitHub Secrets: OAuth credentials protected
  • Validation: Data quality enforced automatically
  • Auto-Deploy: No manual portfolio generation

How It Works

1. Authentication

Student logs in with GitHub OAuth

2. Edit Form

Fills out 26+ fields with validation

3. Save to GitHub

Changes committed automatically

4. Auto-Deploy

Portfolio published instantly

Student Management

1

Add Students to Authentication Database

Students must be added to the encrypted students.json file for authentication. Contact your system administrator for access and detailed instructions.

📋 Required Student Information:

  • id: Username (e.g., "jdoe001")
  • name: Full name
  • email: @regis.edu email address
  • githubUsername: GitHub account username
  • program: "MSDS" or other program code
  • graduationDate: Expected graduation (YYYY-MM-DD)
{
  "id": "jdoe001",
  "name": "John Doe",
  "email": "jdoe@regis.edu",
  "githubUsername": "johndoe",
  "program": "MSDS",
  "graduationDate": "2025-12-15",
  "portfolioPath": "profiles/jdoe001/jdoe001.html",
  "active": true,
  "createdAt": "2025-01-15T10:30:00Z"
}
2

Students Create Portfolios via Web Editor

Direct students to login at editor.regisportfolio.com and create their portfolios using the form-based editor.

👨‍🎓 Student Workflow:

  1. Click "Login with GitHub" on the editor homepage
  2. Authorize the Regis Portfolio Editor application
  3. Fill out the 26+ field form with their information
  4. Upload avatar image (with cropper tool)
  5. Upload practicum reports and presentations
  6. Preview their portfolio in real-time
  7. Click "Save Changes" to commit to system
3

Automatic Portfolio Deployment

When students save their changes in the web editor, portfolios are automatically generated and deployed to regisportfolio.com via GitHub Actions.

⚡ Automatic Workflow:

  1. Student clicks "Save Changes" in the editor
  2. Editor saves the data
  3. System detects the commit
  4. Regis branding and styling applied
  5. Portfolio deployed to live website

Managing Spotlight Projects

What are Spotlight Projects?

Spotlight projects are exceptional student work featured prominently on the homepage. They showcase the best examples across all semesters and inspire current students.

Adding a Spotlight Project (Manual Process)

Spotlight projects are manually curated by instructors. To add a project to the spotlight section, update the spotlight.json file in the main repository's data folder:

{
  "spotlightProjects": [
    {
      "studentName": "Alice Johnson",
      "projectTitle": "ML-Based Predictive Analytics Platform",
      "description": "Innovative platform using advanced ML algorithms for real-time data analysis...",
      "github": "https://github.com/alicejohnson/ml-analytics",
      "demo": "https://alice-demo.herokuapp.com",
      "profilePage": "profiles/ajohnson.html",
      "tags": ["Machine Learning", "Analytics", "Python", "Real-time"],
      "achievements": ["Best Technical Innovation", "Industry Partnership Award"],
      "semester": "2025-spring",
      "course": "MSDS696"
    }
  ]
}

Quick Reference & Resources

LaTeX Report Template

Professional formatting for practicum reports

Template Features:

  • Professional academic formatting
  • Pre-configured report sections
  • Citation & bibliography support
  • Regis University branding
Download Template

Instructor Best Practices

Tips for successful semester management

Key Tips:

  • Add students early in the semester
  • Curate spotlight projects monthly
  • Encourage complete portfolio profiles
  • Review student submissions regularly

Pro Tip: Schedule monthly reviews of student portfolios to ensure quality and completeness.