Skip to content

Module

Jump to bottom
Ashley S edited this page Dec 8, 2021 · 6 revisions

Naming the Module

  1. Type in NAME =

Required Imports

Import required files like analysis or pipeline files.

Define COURSE_AGGREGATORS

The outgoing APIs that send course information to the dashboards.

  1. "sources": is used to set the sources to the reducers whose outputs are aggregated. In this case it is the time spent on a task and the reconstruct reducers.
  2. "cleaner": Passes each individual student through a specified cleaner.
  3. Use "aggregator" to pass an array of the output through a specified aggregator.
  4. Return information to the dashboard of a student that doesn't have any data by declaring "default-data" and inputting the desired information in there. If the student does have data, they shouldn't have the fields that involve reconstruction or the time spent on the task.

Define STUDENT_AGGREGATORS

Processes the incoming information related to the students.

Define Reducers

Controls the incoming event APIs. It has the context and function for the APIs to use.

  1. Declare a 'context' for the reducer to use.
  2. Define a 'function' that specifies the specific function to use. If the function is in a different file, make sure to import that file.

Define THIRD_PARTY

Contains the required client-side JavaScript downloads

  1. Input the file name
  2. Each required JavaScript download requires a url where you can find and download the required file. Additionally, it needs a unique hash to go with it.

Define STATIC_FILE_GIT_REPOS

Works to support using static files from the git repo of the module using the 'url'.

  1. Gets a copy of the repository if it is not already on the system.
  2. The 'prefix' is where the static files are contained in the repo.
  3. The 'whitelist' section separates which branches are whitelisted (available) or blacklisted (blocked).

Define COURSE_DASHBOARDS

The dashboards for the different courses the teacher has. This section sends all the information gathered above for courses to the website to be displayed in the course dashboards UI.

  1. 'name': Input the name of the dashboards
  2. 'url': The url that you want the information to be sent to
  3. "icon": The icon that you want to display on the UI. Contains the type the icon is and the name of the icon file.

Define STUDENT_DASHBOARDS

The dashboards for the students in the teacher's courses. Sends all the information gathered from the above sections about the students to the website to be displayed in the student dashboards UI.

Clone this wiki locally