INSTRUCTOR_GUIDE.md

md10 kBIn solution.zip

📘 Instructor Guide - React Exam Template System

Overview

This template system provides students with a fully-styled React application framework where they only need to implement React logic. No CSS knowledge required.


📦 What's Included

For Students:

  1. Complete CSS (src/index.css) - 400+ lines of production-ready styles
  2. Component Templates - Full JSX structure with TODO comments
  3. Sample Data - 6 events to test with
  4. Documentation:
    • README.md - Project overview
    • QUICK_START.md - Setup guide
    • COMPONENT_TEMPLATES.md - Code to copy (main resource)
    • CSS_QUICK_REFERENCE.md - Class lookup table
    • TEMPLATE_SYSTEM_OVERVIEW.md - System explanation

Project Structure:

react-part/
├── TEMPLATES/                    ← Student documentation
│   ├── QUICK_START.md
│   ├── COMPONENT_TEMPLATES.md   ← Main resource
│   ├── CSS_QUICK_REFERENCE.md
│   └── TEMPLATE_SYSTEM_OVERVIEW.md
├── src/
│   ├── components/              ← Students create files here
│   ├── index.css                ← Complete styling
│   ├── App.jsx                  ← Starter (to be replaced)
│   └── main.jsx
├── README.md
└── package.json

🎯 Educational Philosophy

What Students Learn:

  • ✅ State management with useState
  • ✅ Derived state (no useEffect for filtering)
  • ✅ Controlled components
  • ✅ Event handling
  • ✅ Conditional rendering
  • ✅ Form validation
  • ✅ Props passing
  • ✅ Component composition

What's Abstracted:

  • ❌ CSS/Styling
  • ❌ Build configuration
  • ❌ Project setup
  • ❌ Design decisions

Focus: Pure React concepts without styling distractions


🚀 Student Workflow

Step 1: Setup (5 min)

Shell
npm install
npm run dev

Step 2: Study (10 min)

  • Read exam instructions
  • Review COMPONENT_TEMPLATES.md
  • Understand requirements

Step 3: Implementation (70 min)

  1. Create EventCard.jsx - copy template, implement TODOs
  2. Update App.jsx - add state and filtering
  3. Create FilterPanel.jsx - implement controls
  4. Create EditEventForm.jsx - add validation
  5. Create StatsDashboard.jsx - calculate stats
  6. (Optional) Bonus registration component

Step 4: Testing (5 min)

  • Test all filters
  • Verify validation
  • Check conditional rendering
  • No console errors

📚 Template Files Explained

1. COMPONENT_TEMPLATES.md (Main Resource)

Purpose: Copy-paste code for all components

Contents:

  • Complete App.jsx template
  • EventCard component template
  • FilterPanel component template
  • EditEventForm component template
  • StatsDashboard component template
  • Bonus: RegistrationForm template
  • Sample data array

Usage: Students copy code blocks into their files

Key Feature: Every line is either:

  • Complete working code, OR
  • Commented with // TODO and explanation

2. QUICK_START.md

Purpose: Setup and tips

Contents:

  • Installation steps
  • File structure overview
  • Testing checklist
  • Common mistakes
  • Time management

3. CSS_QUICK_REFERENCE.md

Purpose: Quick lookup for CSS classes

Contents:

  • All class names organized by category
  • Usage examples
  • Common patterns
  • Pro tips

4. TEMPLATE_SYSTEM_OVERVIEW.md

Purpose: Understanding the system

Contents:

  • What's provided vs what to implement
  • How to use templates
  • Verification points
  • Grading focus

🎨 CSS System

Pre-written Styles Include:

Layout:

  • Container system
  • Card components
  • Grid layouts (2 & 3 column)

Components:

  • Event cards with hover/selected states
  • Form inputs with error states
  • Buttons (primary, secondary, danger)
  • Badges (workshop, talk, status)
  • Modal/overlay system
  • Alert boxes
  • Statistics cards

Utilities:

  • Spacing (margins)
  • Flexbox helpers
  • Text alignment

CSS Variables:

CSS
--primary: #2563eb
--success: #10b981
--warning: #f59e0b
--danger: #ef4444
--gray-* (50-900)
--spacing-* (xs-xl)
--radius-* (sm-lg)
--shadow-* (sm-lg)

Students never touch CSS - they just use class names


📝 Grading Strategy

Full Points Criteria:

Q1: Event Dashboard (35 pts)

  • ✓ State initialized correctly
  • ✓ Filtering uses derived state (no useEffect)
  • ✓ All filter conditions combined with &&
  • ✓ Event cards render with correct badges
  • ✓ Selected state highlighted
  • ✓ Empty state displays when appropriate

Q2: Filter Panel (20 pts)

  • ✓ All inputs are controlled
  • ✓ Filter summary updates correctly
  • ✓ Reset button conditionally visible
  • ✓ Reset functionality works

Q3: Edit Form (30 pts)

  • ✓ Form initialized from event data
  • ✓ All inputs controlled
  • ✓ Validation implemented correctly
  • ✓ Errors show only after touch
  • ✓ Conditional fields for workshop type
  • ✓ Submit disabled when errors exist
  • ✓ Capacity validation vs registered count

Q4: Statistics (15 pts)

  • ✓ All metrics calculated (not stored)
  • ✓ Calculations correct
  • ✓ Updates when filters change
  • ✓ High occupancy alert conditional

Bonus: Registration (10 pts)

  • ✓ Form validation works
  • ✓ Seat count updates
  • ✓ Registration tracking

Common Deductions:

Issue Points Lost Severity
Using useEffect for filtering -10 Major
Storing derived state -5 Major
Uncontrolled inputs -3 each Moderate
Missing validation -5 Moderate
Validation shows before touch -3 Minor
Console errors -2 each Minor
Poor variable names -2 Minor
Missing student info -10 Administrative

🧪 Testing Student Solutions

Automated Checks (if desired):

JavaScript
// Check for useEffect abuse
const hasUseEffect = code.includes('useEffect');
const hasFilterInEffect = code.includes('useEffect') && code.includes('filter');

// Check for controlled inputs
const hasValue = code.match(/value=\{/g);
const hasOnChange = code.match(/onChange=\{/g);

// Check for derived state
const hasDerivedState = code.includes('const filteredEvents =');

Manual Testing Checklist:

  1. Run npm install && npm run dev
  2. Check browser console for errors
  3. Test filter combinations
  4. Try to submit invalid form
  5. Change event type in form
  6. Check statistics update with filters
  7. Verify no warnings in console

🎓 Expected Student Results

Strong Students (90-100%)

  • Complete all 4 questions + bonus
  • Clean, readable code
  • Proper state management
  • No console errors
  • Time: 70-80 minutes

Average Students (70-89%)

  • Complete all 4 questions
  • Some validation issues
  • Minor console warnings
  • Time: 85-90 minutes

Struggling Students (50-69%)

  • Complete 2-3 questions
  • State management issues
  • Validation incomplete
  • May run out of time

Red Flags:

  • Using useEffect for filtering (didn't understand instructions)
  • Uncontrolled inputs (missed concept)
  • Storing derived state (fundamental misunderstanding)

💡 Instructor Tips

Before Exam:

  1. ✅ Test the template yourself
  2. ✅ Run npm install to verify dependencies
  3. ✅ Check all links in markdown files work
  4. ✅ Print CSS reference card for students (optional)
  5. ✅ Prepare solution key

During Exam:

  • Direct students to COMPONENT_TEMPLATES.md first
  • Remind: "Don't modify CSS"
  • Common help: "Check TODO comments"
  • If stuck: "Look at the template structure"

Common Student Questions:

Q: "Where do I write code?" A: Create files in src/components/, copy from templates, implement TODOs

Q: "How do I style X?" A: Check CSS_QUICK_REFERENCE.md for class names

Q: "My component isn't showing" A: Did you import it in App.jsx? Export it from the component?

Q: "Can I add more CSS?" A: No, use the provided classes only

Q: "Should I use useEffect for filtering?" A: No, calculate during render (derived state)


🔧 Customization Guide

To Change Styling:

  1. Edit src/index.css
  2. Update class names in templates if needed
  3. Update CSS_QUICK_REFERENCE.md

To Add Requirements:

  1. Update exam instructions
  2. Add TODO comments in templates
  3. Update grading rubric
  4. Add to testing checklist

To Simplify Further:

  • Remove bonus question
  • Pre-fill more code (fewer TODOs)
  • Provide more example data
  • Add console.log hints

To Make Harder:

  • Add more validation rules
  • Require TypeScript
  • Add props validation
  • Require accessibility features

📊 Template Statistics

  • Total Files: 8 documentation files
  • CSS Lines: ~400
  • Template Lines: ~800 (with TODOs)
  • TODO Comments: ~50
  • Sample Events: 6
  • CSS Classes: 60+
  • Components: 5 (+1 bonus)

✅ Quality Assurance

Before Distribution:

  • Run npm install successfully
  • Run npm run dev successfully
  • All markdown links work
  • CSS renders correctly
  • Template code has no syntax errors
  • Sample data is complete
  • All TODOs are clear
  • Documentation is complete

Student Feedback Points:

  • "Templates were clear and helpful"
  • "CSS classes were easy to use"
  • "TODO comments guided me well"
  • "Sample data was good for testing"
  • "Documentation was comprehensive"

📈 Success Metrics

Good Indicators:

  • ✅ >80% completion rate
  • ✅ <5% asking CSS questions
  • ✅ Most students finish in time
  • ✅ Code quality is high
  • ✅ Students focus on React logic

Problem Indicators:

  • ❌ Many incomplete submissions
  • ❌ Lots of styling questions
  • ❌ Students running out of time
  • ❌ console.error widespread
  • ❌ Unclear what to implement

🎯 Summary

This template system enables:

  • Pure React assessment (no CSS distraction)
  • Fair evaluation (everyone same styling)
  • Clear guidance (comprehensive docs)
  • Realistic scenario (production-like code)
  • Time efficiency (90 minutes sufficient)

Students gain:

  • Hands-on React practice
  • Real-world component patterns
  • Validation experience
  • State management skills
  • Professional code structure

You gain:

  • Easy grading (focus on logic)
  • Consistent results
  • Clear criteria
  • Reusable template
  • Happy students 😊

Need help? Check the template files or test the system yourself first!

In TEMPLATES/