Commit 904f672d authored by Daniel W Bond's avatar Daniel W Bond
Browse files

does this work for gitlab's flavor of markdown?

parent 5c754de8
Advisor
===
# Advisor
SRCT Advisor is a dynamic web application that lets users create, compare, and
share course trajectories towards graduation. (Not intended as a replacement for
formal academic advising.)
On Contributing
---
## On Contributing
Advisor is still in its very early states and needs all the help it can get.
Even if you don't feel like you can be helpful the more technical aspects, we
......@@ -25,8 +23,7 @@ The project lead for this project is **Daniel Bond**. *dbond2@gmu.edu*
Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information
on this and other SRCT projects, along with other helpful links and tutorials.
Setup
---
## Setup
To get started, you'll need the following installed:
......@@ -63,10 +60,9 @@ I've written some documentation in the docs folder about using the admin
interface and creating some models. Use the same username and password you set
up when you did the `syncdb` command.
How Advisor Works
---
## How Advisor Works
**Models**
### Models
*Courses*
......@@ -82,100 +78,99 @@ null values or
*Trajectories*
**Templates**
### Templates
<table>
<tr>
<td>
Template Name
</td>
<td>
Function
</td>
</tr>
<tr>
<td>
index
</td>
<td>
This is where students can create a new trajectory. If students haven't yet
already selected the classes they've taken, they can select those classes
here
</td>
</tr>
<tr>
<td>
create
</td>
<td>
Based on the information passed in from the 'index' page, this page shows
which classes a student is allowed to take the subsequent semester,
depending on the prereqs and coreqs. It will use ajax to allow the student
to select their classes and have their next allowed classes returned until
they have completed their program.
</td>
</tr>
<tr>
<td>
student
</td>
<td>
This template acts as a dashboard for each student, showing their saved
trajectories, allows them to adjust the classes they've taken, etc.
Later along, it will have some social features, like following public
trajectories or seeing what classes their "friends" are taking.
</td>
</tr>
<tr>
<td>
trajectory / course
</td>
<td>
These templates just display a trajectory or a course on their own for
inspection. Trajectories can be made public and shared.
</td>
</tr>
<tr>
<td>
compare
</td>
<td>
This page allows students to compare side-by-side up to three trajectories,
of their own or others that are public. Analytics are preformed over the
selected trajectories and displayed, showing, for instance, which has the
most courses, which has the most courses 300+, and more.
</td>
</tr>
<tr>
<td>
analysis
</td>
<td>
This template (to be created in further on) shows which classes are the most
popular, how long on average each completed trajectory takes, popular classes
for certain parts of a major, and more.
I'd like the site to also have a separate app for taking the classes that a
student wants to take for a given semester, and when that semester rolls by,
it'd perform something along the lines of gmu.schedulizer.com for them,
along with the aforementioned social aspects.
</td>
</tr>
<tr>
<td>
login
</td>
<td>
I'd like this page to have a bit more information, since this is the page
that students will eventually be directed to if they haven't logged in. It
might talk about some of the features and such.
</td>
</tr>
<tr>
<td>
Template Name
</td>
<td>
Function
</td>
</tr>
<tr>
<td>
index
</td>
<td>
This is where students can create a new trajectory. If students haven't yet
already selected the classes they've taken, they can select those classes
here
</td>
</tr>
<tr>
<td>
create
</td>
<td>
Based on the information passed in from the 'index' page, this page shows
which classes a student is allowed to take the subsequent semester,
depending on the prereqs and coreqs. It will use ajax to allow the student
to select their classes and have their next allowed classes returned until
they have completed their program.
</td>
</tr>
<tr>
<td>
student
</td>
<td>
This template acts as a dashboard for each student, showing their saved
trajectories, allows them to adjust the classes they've taken, etc.
Later along, it will have some social features, like following public
trajectories or seeing what classes their "friends" are taking.
</td>
</tr>
<tr>
<td>
trajectory / course
</td>
<td>
These templates just display a trajectory or a course on their own for
inspection. Trajectories can be made public and shared.
</td>
</tr>
<tr>
<td>
compare
</td>
<td>
This page allows students to compare side-by-side up to three trajectories,
of their own or others that are public. Analytics are preformed over the
selected trajectories and displayed, showing, for instance, which has the
most courses, which has the most courses 300+, and more.
</td>
</tr>
<tr>
<td>
analysis
</td>
<td>
This template (to be created in further on) shows which classes are the most
popular, how long on average each completed trajectory takes, popular classes
for certain parts of a major, and more.
I'd like the site to also have a separate app for taking the classes that a
student wants to take for a given semester, and when that semester rolls by,
it'd perform something along the lines of gmu.schedulizer.com for them,
along with the aforementioned social aspects.
</td>
</tr>
<tr>
<td>
login
</td>
<td>
I'd like this page to have a bit more information, since this is the page
that students will eventually be directed to if they haven't logged in. It
might talk about some of the features and such.
</td>
</tr>
</table>
To-do
---
## To-do
**First orders of business**
......@@ -229,5 +224,4 @@ want for that semester.
need to sign in in order to save or compare trajectories... this way prospective
students can put their potential trajectories together
About GMU SRCT
---
## About GMU SRCT
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment