schedulr

About

Requirements 👀
- MMU student with "Active" current student status ONLY.
- Chrome browser ONLY.

Usage 🕹️
Note: Some steps after step 4 may vary depending on your target calendar.

For students:
1. Go to "View My Classes/Schedule > By Class" in CLiC. (Ensure all subjects are expanded)

For lecturers:
1. Go to "Instructor WorkCenter > My Weekly Schedule" in CLiC.
---
2. Open the extension by using the shortcut key or by clicking the extension icon.
3. An authentication window will appear, grant permission for both scopes and then reopen the extension.
---
To import calendar into Google Calendar:
4. Select Transfer to Google Calendar, then click Confirm.
5. Select all the necessary options.
6. Press the Submit button to transfer timetable to Google Calendar.
---
To import calendar into other calendars (like Outlook, Apple Calendar):
4. Select Download an .ics file, then click Confirm.
5. Select all the necessary options.
6. Press the Submit button to download the .ics file.
7. Go to your target calendar and import the .ics file.

Tip: An .ics file lets you import events into other calendar apps like Outlook.

Key binding ⌨️
The shortcut key opens up the popup page
- Linux and Windows: Alt+Shift+S
- macOS: Command+Shift+S

Contributing 🤝🏻
Schedulr is an open-source project designed to assist fellow MMU peers. I invite you to participate in various ways to contribute and enhance the project!

Feel free to explore the contribution guidelines (https://github.com/sycanz/schedulr/blob/main/.github/CONTRIBUTING.md) below to get started. Your involvement is greatly appreciated!

Tech Stack 🚀
1. Javascript
2. Google calendar API

Changelog 📁
Detailed changes for each release are documented in the release notes.

Privacy policy 📜
Please read the Privacy Policy for this extension before proceeding.

License ⚖️
This project is licensed under the GNU General Public License v3.0 - see the LICENSE on GitHub

Buy me a coffee ☕
I seem to have developed a bit of an addiction to espresso shots, so if you're feeling generous, feel free to buy me a coffee (find the link on schedulr website or my GitHub repo)!

Credit 🤝🏻
This project was developed at Hackerspace MMU. Also shoutout to a couple of friends who helped me out on this project.

Frequently Asked Questions (FAQs) 🤔
Q: What browser does Schedulr currently support?

A: Google Chrome as of now.

Q: Do I have to pay for this extension?

A: No, Schedulr is free to use for all active MMU students/lecturers and open-source.

Q: Why are some of my classes not showing up in the timetable?

A: Ensure you have expanded all subjects in the "By Class" page.

Q: Do I need to grant permission every time I open the extension? And should I grant permission for both scopes in the authentication window?

A: You only need to grant permission once and you're good to go. And yes you absolutely should grant permission for both scopes, otherwise the extension will not work properly.

Q: Should I be worried about my privacy when using this extension?

A: No, the extension only reads your timetable and transfers it to your calendar. It does not store any personal data.

Q: Can I use this extension for other universities?

A: No, this extension is specifically designed for MMU students and lecturers only.

Q: Are there any plans to support other browsers?

A: Maybe in the future, but for now, the focus is on Chrome.

Q: Can I rely on this extension for my timetable?

A: Somewhat, reason being CLiC might have unexpected bugs or changes that might affect the extension.

Q: How can I contribute to this project?

A: There are things like bug fixes, feature requests, code, and documentation that you can contribute to. Check out the contribution guidelines

Q: Where can I get any help or support?

A: Check if the encountered issues are mentioned in this documentation. If not, you can communicate with me through email, issue tracker, or discord