/comfortable-sakai

A Web browser Extension for improving UX of Sakai LMS

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Comfortable Sakai

License Release CodeQL
npm test

A Web browser Extension for improving UX of Sakai LMS.
Originated from Comfortable PandA for Kyoto Univ.

Supported Sakai LMS versions

  • Sakai 20, 21(Stable)
  • Sakai 12(Unverified)

How to install Comfortable Sakai

Google Chrome & Edge

Download from Chrome Web Store

Firefox

Download from Firefox Addons

Safari

Download from App Store

Documents

Documentation for developers is available at GitHub pages.
Comfortable Sakai Document

Features

Color-coded course site tabs

Colors course site tabs according to the assignment due date.

  • RED Due date within 1 Day
  • YELLOW Due date within 5 Days
  • GREEN Due date within 14 Days
  • GRAY Due date over 14 Days

Notification Badge

Tells your unchecked latest assignments.
Notification badge will appear in the upper left-hand side of a course site tab.

If you open a course site with the notification badge on, the badge will disappear.

miniSakai (List of assignments and quizzes)

Click ☰ to open miniSakai. All available assignments as well as quizzes will be displayed. You can add your custom assignment to miniSakai as memo with PLUS button located on the upper right side.

Also check box is available for you to distinguish completed assignments from working assignments.

Cache

In order to reduce the network load on Sakai LMS, we have implemented a cache function for fetching assignments and quizzes from REST API. The default cache interval is as follows:

  • Assignment fetching --- 2 minutes
  • Quiz fetching --- 10 minutes

The cache time can be changed in the configuration tab in miniSakai.

Screenshot

How to compile from source code

Run

npm install
export NODE_ENV=production
npm run build:all

in the root directory of cloned repository.
zip files will be placed under dist/release directory.

How to run tests

npm run test

License

Apache-2.0 License