README.md

This Ruby on Rails application provides facilities to support a community of
teachers and learners. It currently offers the essentials needed to manage
multiple courses, and we are now also developing other features for enabling
members of the community to work together.

University Web is developed by the
Ruby Mendicant University (RbMU), a
rapidly growing online learning community, and it is our core infrastructure.
We expect it to become potentially useful to other organizations, and hope that
it will be adopted elsewhere as it becomes mature.

Whether you are a member of RbMU or a developer interested in systems for
learning and education, we encourage you to check out the source code:
http://github.com/rmu/university-web

If you are not a member of RbMU, please get in touch through our public channels:

Finally, run the test suite to make sure everything is working correctly:

rake test

Using University Web

Users

University Web user accounts may be either admins, students, or guests.

Every account is identified by email address.

The admin users may access all of the management features of University Web by
choosing Administration from the navigation menu at the top of page.

The management features of University Web enable admin users to perform the
standard tasks for running courses, such as creating other user accounts for
students and guests, defining the courses and managing assignment submissions.

Terms

Each term is a group of one or more courses.

To create a new term, login as an admin user, and choose
Administration > Terms > Create Term.

Courses

To create a new course, choose Administration > Courses > Create New Course.

Once you have created a course, use the course form to attach a user to it as
an instructor, along with students and assignments. The next section explains
assignments.

You may group courses into terms. Courses don't have to be associated with a
term.

Assignments

Each course may have one or more assignments attached to it.

To create or manage assignments for a course, choose
Administration > Courses, click on the Assignments link next to the
name of the course, and choose Create New Assignment.

Once an assignment has been created, some or all of the students in the course
may then be set that assignment.

The students may use the University Web interface to submit work for an
assignment.

The course instructor can then review the submissions for an assignment, and
take appropriate actions, such as commenting or marking the assignment as
completed.

Github Integration

After a student makes a submission for an assignment, an instructor needs
to review the student's code. For this reason, University Web shows the
student's github commit activity on the submissions page.

In order to configure this integration, the student should set their
github username on the profile page and set the github repository specific to
each assignment on the submissions page.

Once configured, University Web will periodically check for new github commits.
It may take up to 15 minutes before new commits will appear on the submissions
page.