MoodleBooster 🚀

Firefox & Chrome extension / add-on that boosts moodle's UI/UX
You can download our production version add-on on Mozilla's website / Chrome Web Store.

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 (🔥Firefox) or Chrome (🌊Chrome).
• Install Node.js and NPM if not already installed: on Windows, on Ubuntu (Currently we support vesrions : node>=12.0.0 , 7.0.0>npm>=6.9.0)
• 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.
  • Run the Extension:
    • On Firefox - From the root directory of the project run npm start.
    • On Chrome - From the root directory of the project run npm run start-chrome.

Second Way:

• Firefox
  • Download Firefox (🔥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.
• Chrome
  • Download Chrome (🌊Chrome).
  • Clone the repo to your pc, by running the following command: git clone https://github.com/norbit8/MoodleBooster.git.
  • Go to Chrome and type: chrome://extensions/ on the search bar.
  • Click on "Load unpacked" and choose the root folder of the project.

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/

• This moodle extension is designed to work mainly on Huji's moodle.

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 the repository (or if you're a contributor just clone this repo).
2. Open a new branch (locally) and start working on it.
3. Push it.
4. Create a new pull request.
5. Add new tag to main branch after pull request merge (Thank you! ❤️)

✨ Contributors ✨

Thanks goes to these wonderful people (emoji key):

Yoav 🚇 💻 📖	idan2468 🚇 💻 📖	yanirelfasy 🚇 💻 📖	tamiror6 📖 💻 🚇	DanielSaroussy 📖	dorpro13 📖	guys1915 📖 💻
shakedkialy 📖	Nataly Milman 📖	ori-frenkel 📖	rbenjos 📖	Koral Haham 📖

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