MoodleBooster 🚀

Firefox (Soon to be Chrome) extension / add-on that boosts moodle's UI/UX You can download our production version add-on on Mozilla's website.

Table of Contents

• Running Instructions
• Notes
• How To Contribute?
• Contributors

Running Instructions

There are two ways to run our extension, the difference between them is that by using the first way you can have hot-reloading, while developing.You don't have to add the extension if you run locally.

First Way (Recommended):

• Download Firefox (🔥).
• Clone the repo to your pc, by running the following command: git clone https://github.com/norbit8/MoodleBooster.git.
• Run npm install in the root directory of the project to install all dependencies.
• From the root directory of the project run npm run start to start firefox with the web extension, then browse to moodle.

Second Way:

• Download Firefox (🔥).
• Clone the repo to your pc, by running the following command: git clone https://github.com/norbit8/MoodleBooster.git.
• Go to Firefox and type: about:debugging#/runtime/this-firefox on the search bar.
• Click on "Load Temporary Addon" and choose any file from the repo you've just cloned.

In order to build the extension into zip file run npm build from the root of the project

Notes:

• The dev environment support many features that include with web-ext like hot-reloading more info here: https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/

How To Contribute?

Pushing code to our master branch is forbidden.

If you want to contribute, all you need to do is to

1. Fork this repo.
2. Open a new branch (locally) and start working on it.
3. Push it.
4. Create a new pull request. (Thank you! ❤️)

✨ Contributors ✨

Thanks goes to these wonderful people (emoji key):

Yoav 🚇 💻

idan2468 🚇 💻

yanirelfasy 🚇 💻

tamiror6 📖

This project follows the all-contributors specification. Contributions of any kind welcome!