BBcatcher: Your Academic Scheduler Browser Extension for Firefox

BBcatcher simplifies the life of students by seamlessly integrating their academic schedule within their browser. Whether it's exams, quizzes, or homework, BBcatcher ensures you're always ahead of your schedule. Initially crafted for Humber College's learning management system, it possesses the flexibility to adapt to other educational platforms with ease.

Core Features

Automatic Calendar Integration: Exams, quizzes, and homework are instantly added to your calendar.
Real-Time Notifications: Stay updated with upcoming deadlines through timely notifications.
Google Calendar Synchronization: Effortlessly syncs with Google Calendar to keep your schedule at your fingertips.
Adaptable to Various Learning Systems: While tailored for Humber College, BBcatcher can be configured to work with other learning management systems.

Quick Installation Guide

Getting BBcatcher up and running on your Firefox browser is a breeze. Just follow the outlined steps:

Navigate to the BBcatcher's GitHub repository and download the latest release.
Unzip the downloaded files into a preferred directory on your machine.
Launch a terminal window and change the directory to where you've extracted the files.
Execute the command npm install --global web-ext to install web-ext.
To launch the extension, run the command: web-ext run.
Firefox will spring to life with BBcatcher extension installed and active.

Pro Tip: For packaging the extension for distribution, leverage the web-ext build command in place of web-ext run. This will conjure a .zip file ready for distribution.

How to Use BBcatcher

Harness the power of BBcatcher in a few easy steps:

Launch the Humber College learning management system on your browser.
Navigate to the desired course you wish to integrate with your calendar.
Click on the BBcatcher icon situated in your browser toolbar.
Hit the "Add to Calendar" button.
Select the calendar you wish to add the event to.
Click "Save" to finalize.

Contribute to BBcatcher

Your ingenuity and code contributions are invaluable to BBcatcher's evolution. Here's a step-by-step guide on how you can contribute:

Forking the Repository:
- Visit the BBcatcher repository on GitHub.
- Click on the "Fork" button situated at the top right corner of the page. This action will create a copy of the repository under your GitHub account.
Cloning Your Fork Locally:
- Open Git Bash on your machine.
- Navigate to the directory where you want to clone the repository using the cd (change directory) command. For example: cd /path/to/your/directory.
- Now clone your forked repository by executing the following command:
```
git clone https://github.com/YOUR-USERNAME/BBcatcher---Firefox.git
```
Creating a New Branch:
- Change to the repository's directory: cd BBcatcher.
- Create a new branch for your changes, naming it descriptively:
```
git checkout -b descriptive-branch-name
```
Committing Your Changes:
- Make your desired changes in the code.
- Once done, stage the changes by executing:
```
git add .
```
- Now, commit these staged changes with a meaningful message:
```
git commit -m "A detailed message describing the essence of your changes"
```
Pushing Changes to Your Fork:
- Push your committed changes to your fork on GitHub:
```
git push origin descriptive-branch-name
```
Initiating a Pull Request:
- Head back to your forked repository on GitHub.
- Click on the "Pull requests" tab, followed by the "New pull request" button.
- Ensure the base repository is set to BBcatcher/BBcatcher and the base branch is main. Your fork should be the compare repository and your descriptive branch name should be the compare branch.
- Click on the "Create pull request" button, provide a detailed description of your changes, and submit your pull request for review.

Follow these steps diligently to ensure a smooth contribution process. Your efforts in enhancing BBcatcher are highly appreciated!

License

BBcatcher is graciously made available under the MIT License. For more details, see LICENSE.

Explore BBcatcher on Chrome

For Chrome aficionados, BBcatcher has a sibling! Discover the BBcatcher Chrome Extension and enjoy the same streamlined academic scheduling.

MashdorDev / BBcatcher---Firefox