ufosc / course-scheduler

A dynamic course scheduler for planning out college semesters.

Course Scheduler

A dynamic course scheduler for planning out college semesters.

Goals

Course planner that can suggest a sequence of courses based on constraints such as:

1. Core / compulsory courses
2. Individual interest
3. Credit / ease of completion (i.e. easy grades vs. net learning value)
4. & more (suggest stuff on our issues page!)

Contributing

See our contributing guidelines

Resources

We have a wiki that is currently being built, but check out the following resources:

Frontend (React / Typescript / CSS)

• Lynda's typescript series
• Microsoft's React + Typescript series

First time with react?

• Code Academy

UI Design

• Material Design Components

Backend (Python)

• Python 3 standard docs
• Full Stack Python Resources

TODO

Look at our projects or issues page!

course-scheduler's Issues

Create a flask / tornado application for modelling the API

Update package.json

Currently running a dev-server runs two separate and somewhat redundant commands (a constant compile and a server). The server should compile by it's self, but does not. Try fixing the configuration on the typescript branch so it isn't quite as wasteful. Be sure to test on different operating systems.

Connect to Database

Have the frontend pull and display data

Design course sorting algorithm

Algorithm to sort classes into semesters based on prerequisites and difficulty. Must account for different course loads from semesters (summer is less than fall/spring).

Implement unit testing

Test database communication and data sanitation. Keep in mind things like no communication, bad data, etc

Need to add a always available server

Hoping to discuss this and get a server to use

Basic React mock up

Put together a basic react system to allow for testing on the typescript branch. Should have a overall schedule with basic meta data, that displays a list of semesters with basic metadata, that displays a list of courses with basic meta data. Look at the corresponding typescript classes for source of data.

Create some designs/mocks as starting points for discussion

The objective is to have some basic design documentation for the UI/UX of this application started.

Get Major Requirements from One UF

Must log into the One UF degree audit to connect. This is not ideal. In addition, it uses whatever year you started as. However it provides a JSON with all the requirements, which is nice and more reliable than the static web page from the majors catalog.

Need to account for unselected electives

Place a blank elective in the schedule that accounts for the credits. Then allow the user to select a specific course from a list.

Align README.md with current state. (Rework this thing, with run examples / workflow examples)

README.md is currently far too generic. We need to update it so that new people coming in can see what this project is about and how to get started ASAP.

Current suggestions:

• Add a section on getting started (what you need to know / learn about)
• Adding a Contributing guidelines section
• Usage examples (?)

Suggestions on info to add welcome!

Implement Unit Test

Add unit test to verify frontend functionality specified in issue #16

Add Frontend Functions

Select major/minor, search courses, add courses, remove courses, move courses, save selection, load previous save

Add notes and relevant files on workflow, code style (.editorconfig for all languages)

I believe we can cover code style with standard PEP8 requirements. Here is a sample .editorconfig I plan to use for enforcing this (we can agree on something that works for all of us since we need to be able to read the code as well)

root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

[*.py]
charset = utf-8
indent_style = tab
indent_size = 4

[Makefile]
indent_style = tab
indent_size = 4

Decide common storage format

JSON flat file currently

Identify endpoints / Pages for data sources

#We need to identify API endpoints for various pieces of information to completely build the dependencies for all of the courses.

Status:

Purpose	Endpoint	Docs/Wiki	Comments
Schedule	https://one.uf.edu/apix/soc/schedule/?term= $TERM &category= $CATEGORY &lastrow=$LASTROW	TODO	There are more parameters check the wiki for info.
Description	https://one.uf.edu/apix/soc/cdesc/ $COURSE_CODE	TODO	This is the only query parameter, however we may need to build a crude parser for the response containing pre-reqs/coreqs.
Dependencies	TODO	TODO	Course description offers some rough unstructured info, but can we do better?
Evaluations	TODO	TODO	Evaluate using the evaluations page for this info

Assignments:

Dependencies - @pikachuster

Updates

Schedule - Scrapy project
Dependencies / Descriptions - Currently being added to the scrapy based code.
Evaluations - Probably going to use scrapy / selenium here whichever comes through first reliably