Skip to content

Mentor Statistics is an Chrome/Firefox extension that help you have more information on your incomes when you are an OpenClassRooms Mentor.

License

Notifications You must be signed in to change notification settings

gaelgthomas/mentor-statistics-openclassrooms

Repository files navigation

Mentor Statistics OpenClassRooms (DEPRECATED)

Mentor Statistics is an Chrome/Firefox extension that help you have more information on your incomes when you are an OpenClassRooms Mentor. This extension is only working for French mentors at the moment. With this extension you will have a new tables on your mentorship sessions history with these values for the current and 2 last months:

  • Total number of mentoring sessions (by level and total)
  • Total number of no-shows sessions (by level and total)
  • Global statistics (hourly average, mentoring hours, total income)

Important about OpenClassRooms

This extension is non-official. After an exchange by email, the extension can be delivered publicly, but is in no way an official source to OpenClassRooms. The information delivered by the extensions cannot be used as reference with the OpenClassRooms team.

Thanks to OpenClassRooms to accept the publication of this extension.

How to get the extension ?

This extension is downloadable on the Firefox Add-ons Store and the Chrome Web Store.

How to run ?

Once you have downloaded the extension, when you go on the mentorship sessions history, a new table appear and the information start to appear. The extension is a parser, you need to wait a little bit before getting all your current incomes.

Install locally

If you want to install locally the extension you need to clone it on your computer and follow these steps to run it.

Firefox

In order to run the extension locally with firerox you need to open the following in the URL bar:

about:debugging

When the page is loaded, you need to click on "Enable add-on debugging" the center top. Once you have activated this mode, you need to click on "load temporary add-on" to run the extension locally. A pop-up will appear and ask you to find the manifest.json in extension folder. You need to select the manifest.json in Mentor-Statistics-OpenClassRooms folder.

Please note, if you change the source code of the extension, remember to reload or your changes are going to not be done.

Chrome

In order to run the extension locally with chrome you need to open the following in the URL bar:

chrome://extensions/

When the page is loaded, you need to activate developer mode at the right top of the page. Once you have activated this mode, a new menu bar appear. You need to click on "load unpacked" to run the extension locally. A pop-up will appear and ask you to find the extension folder. You need to select the Mentor-Statistics-OpenClassRooms folder.

Now you have the extension locally on your chrome browser.

Please note, if you change the source code of the extension, remember to reload or your changes are going to not be done.

Documentation

All code is commented with JSDoc. Node.JS is required to use JSDoc. Follow these steps to install it on your computer:

  • Windows - Install on Windows.
  • MacOSX - Install on MacOSX.
  • Ubuntu - Use the command below:
$ sudo apt install nodejs npm

When you have downloaded Node.JS, open a terminal and install JSDoc with this command:

$ npm install -g jsdoc

When JSDoc in installed, you can access to a documentation in the root of the repository by typing the following command:

$ jsdoc -r src/

A out/ folder is generated. Launch out/index.html with your browser to watch documentation.

Built with

  • JQuery 3.3.1 - Fast, small, and feature-rich JavaScript library.
  • Table-to-JSON - A jQuery plugin that converts an HTML Table into a javascript object.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

For the versions available, see the tags on this repository.

Authors

Contributors

  • Gahfy - English implementation + Bug fix - gahfy
  • Aiwanesk - Bug fix - aiwanesk

License

This project is under license - see the LICENSE.md file for details.

About

Mentor Statistics is an Chrome/Firefox extension that help you have more information on your incomes when you are an OpenClassRooms Mentor.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published