Home

Welcome to MarkUs

MarkUs (pronounced "mark us") is an open-source tool which recreates the ease and flexibility of grading assignments with pen on paper, within a web application. Designed to support programming assignments, students may submit their work through the web interface or through a version control system. Students can form groups to collaborate on assignments. Instructors add marking schemes, assign graders to students and then later release the marks to the students. The graders can view the students submissions, fill in the marking schemes, and annotate the students work. MarkUs facilitates much of the administrative work of setting up and grading an assignment.

MarkUs is written using Ruby on Rails, and uses Subversion to store the student submissions. MarkUs is the successor to the OLM project, an earlier grading tool.

MarkUs Users

• User Guide
  • Instructor Guide
  • Grader Guide
  • Student Guide
  • RESTful API

Users may also find the Sandbox useful.

Developer Resources

If you are interested in contributing to MarkUs, there is lots of information below to help you get set up. Please help us keep this documentation up to date!

The Developer's Blog has quite a few useful posts to help you get started or understand design decisions that were made along the way. It also includes status reports from various terms.

Project communication:

• IRC Channel: #markus on irc.freenode.net

  • Logs of the channel are also available.

• Mailing list address: markus-dev@cs.toronto.edu

  • Mailing list archive at marc.info

Most of the low-level technical discussion takes place on the Issue list <https://github.com/MarkUsProject/Markus/issues> and in Code Reviews . There is a Guide to creating MarkUs Code Reviews

• Git Resources:
  • MarkUs and Git
  • A Git Tutorial
  • Progit Book
  • Gitref.org
  • Git Backend Wiki
• Issue Labels
• Updating the Wiki

MarkUs Developer Installation Guides

GNU/Linux

• Setting up a development environment on GNU/Linux

Mac OS X

• Setting up a development environment on Mac

Windows

NOTE: Windows is not supported anymore

• Setting up a development environment on Windows using InstantRails (DEPRECATED)

Setting up the Database

• SQLite
• MySQL
• PostgreSQL

MarkUs Developer Documentation

Project Vitals

Repository: Create a GitHub account and fork MarkUsProject/MarkUs (see GitHub help for more info).

Screencasts

• Student File Submission: September 2 2009
• Student Group Formation: August 17, 2009
• The Grader View: June 6, 2009
• Flexible Marking Scheme Selection: December 1, 2009
• Flexible Marking Scheme Criterion: December 1, 2009
• Notes created through the Modal dialog as an Admin: December 3, 2009
• Notes created through the Modal dialog as a TA: December 3, 2009
• Creating and editing a grade entry form as an admin: December 4, 2009
• Notes tab: December 11, 2009
• Entering and releasing the marks for a grade entry form as an admin: April 4, 2010

Project Contributors

Aaron Lee, Adam Goucher, Aimen Khan, Alexander Kittelberger, Alexandre Lissy, Alex Krassikov, Alysha Kwok, Amanda Manarin, Andrew Hernandez, Andrew Louis, Angelo Maralit, Anthony Le Jallé, Anton Braverman, David Das, Arianne Dee, Benjamin Thorent, Benjamin Vialle, Bertan Guven, Brian Xu, Bryan Shen, Camille Guérin, Catherine Fawcett, Christian Jacques, Christine Yu, Christopher Jonathan, Clément Delafargue, Clément Schiano, Danesh Dadachanji, Daniel St. Jules, Daniyal Liaqat, Daryn Lam, David Liu, Diane Tam, Dina Sabie, Dylan Runkel, Ealona Shmoel, Egor Philippov, Erik Traikov, Eugene Cheung, Evan Browning, Farah Juma, Fernando Garces, Gabriel Roy-Lortie, Gillian Chesnais, Geoffrey Flores, Hanson Wu, Horatiu Halmaghi, Ian Smith, Ibrahim Shahin, Jay Parekh, Jeffrey Ling, Jeremy Merkur, Jeremy Winter, Jérôme Gazel, Jiahui Xu, Jordan Saleh, Joseph Mate, Joseph Maté, Justin Foong, Karel Kahula, Kitiya Srisukvatananan, Kurtis Schmidt, Lawrence Wu, Luke Kysow, Marc Bodmer, Marc Palermo, Mark Rada, Mélanie Gaudet, Michael Lumbroso, Mike Conley, Mike Gunderloy, Mike Stewart, Mike Wu, Misa Sakamoto, Neha Kumar, Nelle Varoquaux, Nicholas Maraston, Nicolas Bouillon, Nick Lee, Nicolas Carougeau, Noé Bedetti, Oloruntobi Ogunbiyi, Ope Akanji, Rafael Padilha, Razvan Vlaicu, Robert Burke, Samuel Gougeon, Sean Budning, Severin Gehwolf, Shenglong Gao, Shion Kashimura, Simon Lavigne-Giroux, Su Zhang, Tara Clark, Tiago Chedraoui Silva, Tianhai Hu, Valentin Roger, Veronica Wong, Victoria Mui, Victor Ivri, Vivien Suen, William Roy, Xiang Yu, Yansong Zang, Zachary Munro-Cape

Supervisors: Karen Reid, Morgan Magnin, Benjamin Vialle, David Liu

Term Work

Status Reports:

• 2013
• 2012
• 2011
• 2010
• 2009

Everything a Developer Needs to Know about Ruby, Ruby on Rails and MarkUs

• Getting Started with Ruby, Ruby on Rails and MarkUs
  • Short Rails Debugging HOWTO
  • How to program in Ruby, Rubybook
  • Rails 3.0 API
  • Rails 3.2 Guides
  • General Guide Lines to code - Code review from Mike Gunderloy
  • http://apidock.com/rails
  • Some notes from a Ruby book taken by Tara Clark
  • How to use MarkUs Testing Framework (still in alpha)
• MarkUs Coding Style/Coding Practices/Rails Gotchas
  • Basic Guidelines for MarkUs Development (IMPORTANT!)
  • How To Do a Code Review
  • Rails erb quirks
  • Please document your code according to the RDoc specification (see How to Use RDOC)
  • Difference between COUNT, LENGTH, and SIZE
  • Our Ruby/Rails testing guidelines
  • Security testing guidelines
  • Internationalization
• MarkUs API/Test Coverage
  • MarkUs Ruby Doc
  • MarkUs Test Coverage
• MarkUs Releases
  • Preparing a Release and Patch
• User Roles and Stories for MarkUs
  • General / Constraints
    • MarkUs is internationalized
    • MarkUs is configurable
    • Rubrics are not allowed to change once Submissions have been collected
    • Instructor
      • Instructors can create / edit assignments
      • Instructors can download / export files
      • Instructors can hide students
      • Instructors can do everything that Graders can do
      • Instructors can release / unrelease completed marking results
      • Instructors can map particular students / groups to Grader_(s) for marking
      • Instructors can download / export a file that describes the Student /Grouping mapping to Graders
      • Instructors can upload a file that will do the Student /Grouping mapping to Graders
      • Instructors can manage groups without restrictions
    • Grader
      • Graders can easily tell which submissions are assigned to them to mark
      • Graders can view a Submission from a Student / Grouping
      • Graders can view / annotate / mark a particular file from a Submission
      • Graders can add annotations to particular lines of code within a Submission File
      • Graders can create reusable Annotations
      • Graders can create short, formatted overall comments on a Submission
      • Graders can view and use a Rubric for marking a Submission for an Assignment
      • Graders can view a summary of marked submissions
      • Graders can add bonuses / penalties to submissions
      • Graders can modify the marking state of a submission result
      • Graders can easily switch to the next / previous Submission for marking
    • Student
      • Students can view marks of submissions
      • Students can view annotations of marked submissions/assignments
      • Students can submit files for their assignments
      • Students can view / edit submission files for assignments
• Database Schema
  • AutoGenerate Database Schema
    • View Schema Diagram
  • Questions and Answers (Old Document)
• MarkUs Component Descriptions
  • Group / Grouping Behaviour
  • Groupings and Repositories
  • Authentication and Authorization
  • Annotations
  • How Student Work is Graded and Re-graded
  • Submission Rules
  • The FilterTable Class
  • Simple Grade Entry
  • Notes System
• Feedback Notes
  • 2009-05-22: Phyliss
  • 2009-06-22: Ryan
• Tips and Trick
  • Dropping/Rebuilding Database Quickly and Easily
• IDE/Editor Notes
  • jEdit
  • NetBeans
  • Aptana RadRails / Eclipse

MarkUs Deployment Documents

Installation Instructions for MarkUs using RAILS_ENV=production

• Setup Instructions for MarkUs Stable (MarkUs 0.10.0)
• Hosting several MarkUs applications on one machine (for Production)
• How to use LDAP with MarkUs
• How to use Phusion Passenger instead of Mongrel
• Old Setup Instructions for MarkUs Stable (MarkUs 0.5, 0.6, 0.7 and 0.8 branches)

For a complete list of local wiki pages, see TitleIndex.