Rate My Professor GMU Extension

Rate My GMU Professors is a browser extension that enhances the GMU website by displaying professors' ratings and reviews directly on the Patriot Web interface. It supports Google Chrome, Mozilla Firefox, and Microsoft Edge.

Features

• Fetches ratings and reviews from Rate My Professor for each listed professor.
• Displays overall rating, level of difficulty, department, and other relevant information.
• Supports primary instructor identification.
• Provides a direct link to the professor's Rate My Professor page for further details.

Installation

Option 1. From the Web Stores (Recommended)

• Chrome Web Store

• Firefox

• Edge

Option 2. From Source

1. Clone the repository.

2. Open your browser and navigate to the extensions page (chrome://extensions for Chrome, about:addons for Firefox, edge://extensions for Edge).

3. Enable the Developer mode using the toggle switch in the top right corner (if available).

4. Click on the Load unpacked button and select the cloned repository folder (For Firefox, use Debug Add-ons -> Load Temporary Add-on).

5. The extension should now be installed and visible in the extensions list.

Usage

1. Open the GMU Patriot Web interface in your browser.

2. Log in to your account.

3. The extension will automatically fetch and display professor ratings and reviews in the instructor column.

4. Click on the professor's rating to visit their Rate My Professor page for more information.

Development

Prerequisites

• Node.js
• npm
• npx
• Git
• Visual Studio Code (Recommended)
• Prettier (Recommended)
• Browser (Chrome, Firefox, Edge)

Installation

1. Clone the repository.

git clone https://github.com/Jeong-Min-Cho/Rate-My-GMU-Professors.git

2. Install the dependencies.

npm install

3. Build the extension.

npm run build

Production Build

Linux enviroment is recommended. There are three build scripts available:

• npm run prod-chrome - Builds the extension for Chrome in production mode.
• npm run prod-firefox - Builds the extension for Firefox in production mode.
• npm run prod-edge - Builds the extension for Edge in production mode.

I highly recommend you to build the extension for all three browsers to ensure compatibility.

Usage

1. Open your browser and navigate to the extensions page (chrome://extensions for Chrome, about:addons for Firefox, edge://extensions for Edge).

2. Enable the Developer mode using the toggle switch in the top right corner (if available).

3. Click on the Load unpacked button and select the cloned repository folder (For Firefox, use Debug Add-ons -> Load Temporary Add-on).

4. The extension should now be installed and visible in the extensions list.

5. Make changes to the source code.

6. Reload the extension.

7. Repeat steps 5 and 6 until the desired changes are made.

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please create an issue or submit a pull request. Follow these steps to contribute:

1. Fork the repository.

2. Create an issue describing your idea or bug report on the Issues.

3. Create a new branch with a descriptive name.

git checkout -b feature/issue-number/your-feature-name

4. Make your changes and commit them.

git commit -m "(feat#issue-number): Your commit message"

5. Push your changes to your fork.

git push origin feature/issue-number/your-feature-name

6. Open a pull request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or inquiries, feel free to contact me at jeongmincho@outlook.com.