A comprehensive leaderboard Django application for Open edX that displays student rankings based on certificate counts and scores.
Follow these steps to install and configure the openedx-leaderboard plugin:
Install the plugin
tutor plugins install https://raw.githubusercontent.com/edly-io/openedx-leaderboard/refs/heads/master/openedx_leaderboard/leaderboard.py
Enable the plugin
tutor plugins enable leaderboard
Build the images
tutor config save tutor images build openedx tutor images build mfe
Restart the server
tutor local restart
Apply migrations
tutor local run lms ./manage.py lms migrate openedx_leaderboard
The plugin supports the following configuration options:
- COURSE_CERTIFICATE_SCORE: Default score awarded per certificate (default: 50)
- Custom course scores: Configure different scores for specific courses via the Django admin
Once installed, the leaderboard will automatically appear in the learner dashboard sidebar. It will:
- Display the top 10 students ranked by certificate count and score
- Show the current user's position as an 11th row if they're not in the top 10
- Update automatically when new certificates are generated
- Allow clicking on profile images or usernames to view user profiles in new tabs
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
Contributions are very welcome. Please read How To Contribute for details. This djangoapp with its tutor plugin is maintained by Muhammad Faraz Maqsood from Edly. Community support is available from the official Open edX forum. Do you need help with this plugin? See the troubleshooting section from the Tutor documentation.
For issues and support, please visit: - GitHub Issues: https://github.com/edly-io/openedx-leaderboard/issues - Open edX Discussion Forums: https://discuss.openedx.org