Classy

Classy is a classroom management system developed by the Department of Computer Science at UBC. Classy is tightly integrated with GitHub and has the ability to automatically provision student repositories, create teams, and mark assignments. Administrators can configure deliverables, enter grades, and view comprehensive dashboards of all student test executions. Students can use the system to create teams (if required) and view their grades and assignment feedback.

Primary contributors:

• Reid Holmes
• Nick Bradley
• Andrew Stec
• Braxton Hall

Contributing to Classy

Features that add value to Classy should be merged back into the Classy project. Any feature that is practical, improves the administration of a course, and is useful to instructors is likely to add value and be accepted as core code. Features, on the other hand, that are only useful to a single course will likely not be accepted as core code. A feature needs to have adequate code coverage (> 90%) and have been tested for a semester in a downstream fork to be eligible as core code. Bug fixes always have value and can be merged via PR back to ubccpsc/classy as required.

To contribute code to Classy, create a PR that has your code in a feature branch (e.g., feature/my-new-feature) ready to merge into the root ubccpsc/main branch. To ensure that the code is ready to merge, rebase your feature branch on the ubccpsc/main branch. Rebasing will help eliminate any later downstream and upstream merge conflicts. Classy has been configured with CircleCI for validating work. Any PRs must pass the CircleCI test suites.

Any unnecessary files, such as custom back-end and front-end files should NOT be part of the PR. Add unnecessary files to your Global Git Ignore Configuration.

• Contributing to Classy Project

Table of Contents

Instructions for getting started with Classy have been sorted into sections based on the following user roles:

Instructors

• 1. Classy Features
  • 1.1 Portal
  • 1.2 AutoTest
  • 1.4 Github & AutoTest Examples
• 2. Getting Started
  • 2.1 Requesting Classy for Your Course
  • 2.2 Default Classy Views
  • 2.3 Bootstrapping Default Views & Logic
• 3. AutoGrade Setup
  • 3.1 Build a Container Checklist
  • 3.2 QA Container Checklist
• 4. Portal Manual
  • 4.1 Classlist Enrollment
  • 4.2 Deliverable Configuration
  • 4.3 Distributing Assignments and Repository Creation
• 5. AutoTest Manual
  • 5.1 User Types
  • 5.2 Student AutoBot Commands
  • 5.3 Instructor AutoBot Commands
  • 5.4 Avoiding Queue Pile-ups

Developers

• 1. Bootstrapping Classy for Development
  • 1.1 Software Dependencies
  • 1.2 Environmental Config
  • 1.3 Install/Build/Run
• 2. Course Development/Customization
  • 2.1 Application Customization
  • 2.2 Docker Containers/Supporting Services
  • 2.3 Nginx & Routing
• 3. Contributing to Classy
• 4. Setup CircleCI & Coveralls

Technical Staff

• 1. Architecture
  • 1.1 Network Layer
  • 1.2 Application Layer
• 2. Hardware Requirements
• 3. Installation
  • 3.1 Software Dependencies
  • 3.2 Classy Installation
  • 3.3 System Configuration
  • 3.4 Create SSL Certificates
  • 3.5 Configure Firewall Rules
• 4. GitHub Setup
• 5. Backup Configuration
• 6. Build/Start/Stop Classy
• 7. Patching
  • 7.1 Operating System
  • 7.2 Classy
• 8. Term Transitions

License

MIT