BetterCompass - A frontend for JDLF's compass.education written in Vue 2 and Vuetify
BetterCompass
BetterCompass is a frontend for JDLF’s compass.education written in Vue 2 and Vuetify.
The normal Compass frontend has a variety of issues, being made over a decade ago with a growing inconsistent design as it is being updated, it is very slow, the mobile app for students is horrible and buggy (at least on Android) which lacks features, the website isn’t responsive, and feels very neglected overall.
A public instance of BetterCompass can be found at https://compass.troplo.com, which is constantly kept up to date, and is recommended to be used if you don’t want to self host your own instance.
BetterCompass may have missing features that are out of scope, this is likely because I do not have full access to the Compass platform, and feature availability can differ between different instances.
Supported Compass features
Account Types
You may be able to login with unsupported accounts, but the features unique to said account type are unlikely to be available, as it was intended for student accounts.
- Student
- Guest
- Staff
- Parent (Partial support, billing will never be supported for security reasons.)
- Admin
- Visitor
Activities
Learning Tasks
- Uploading submission
- Viewing text feedback
- Responding to feedback
- Rubric
- Viewing learning task details, such as attachments, description, etc.
- Viewing tags (e.g. “Assessment”, “Assignment”, etc)
Roll
- Viewing users in class as student (BetterCompass Exclusive)
Resources
- Downloading resources
- Viewing resource learning task
Schedule
- Viewing class schedule in week, and month modes.
Dashboard
- Viewing current instance learning task
- Viewing current class news
- Viewing current teacher, and location information
- Viewing and creating class notes (BetterCompass Exclusive)
Events
- Event list
- Get event details
- Download event resources
Home
- Daily, and weekly (BetterCompass Exclusive) calendar views
- Viewing personalized school news
- Viewing and creating both Compass-compatible and BetterCompass notes/tasks.
User Profile
- View chronicle entries (and extra information)
- View today’s attendance status
- Attendance history
- Viewing reports
- Analytics (for NAPLAN, etc)
- User learning tasks
Misc
- School Resources
- BetterCompass cache for offline usage on PWA (BetterCompass Exclusive)
- Ability to hide excess calendar header events (BetterCompass Exclusive)
- See overdue learning task amount on homepage (BetterCompass Exclusive)
Subject Learning Task:
BetterCompass uses a proxy for the Compass API to allow for a seamless
integration with BetterCompass. This can be found in /proxy, and can be
run with node ., view setup instructions in proxy/README.md.
Project setup
Rename .env.example to .env and fill it out with your own information.
yarn install
Compiles and hot-reloads for development
yarn serve
Compiles and minifies for production
yarn build
Lints and fixes files
yarn lint