openedx-edly-discussion

Openedx-edly-discussion is an open source Django plugin available for Open edX to use the NodeBB discussion forum as its own discussion app. This plugin works along with the NodeBB plugin i.e. nodebb-plugin-openedx-discussion.

Features

• Provides a fully functional embedded view of NodeBB in the course discussions tab in your Open edX instance.
• Synchronization of Open edX with NodeBB to keep the discussion experience seamless.
  • Whenever a new user is created in Open edX application, the same user is also created in the NodeBB application and the same goes for the courses i.e. whenever a new course is created, a corresponding category is created in the NodeBB application to contain all of the course discussions in one place.
  • It also provides a Django management command to sync existing users and courses of Open edX with NodeBB.
• Session sharing is handled using JWT authentication.
• User privileges are managed using NodeBB groups.
  • Course related discussions are only accessible to the enrolled users of the course.

Prerequisites

• Open edX (hawthorn or later) instance. (Installation link)
• NodeBB (v1.10.x or above) instance. (Installation link)

Getting started

Devstack Setup

You can either use opendx-devstack and apply all configurations yourself or you can simply use the pre-configured openedx-nodebb-devstack.

Using openedx-devstack

• Configure your fresh edX devstack instance using configure edX repo of openedx_edly_discussion wiki.
• Generate a master token for API access of NodeBB using this link.
• Follow the Installation guide steps of nodebb-plugin-openedx-discussion to integrate nodebb-plugin-openedx-discussion plugin in your NodeBB instance.

Using openedx-nodebb-devstack

• Just follow this link and you are done.

Sync already created users and courses of edX with NodeBB

Run following shell commands from devstack directory.

$ make lms-shell
$ ./manage.py lms sync_course_enrollments_with_nodebb
$ exit

$ docker-compose restart lms

Enable Discussion in a Course:

• Open your desired course from Studio.
• Go to Advanced Settings from the Settings tab of the Course.
• Add "openedx_edly_discussion" to the Advance module list and save it.

Documentation

openedx-edly-discussion wiki is the full reference for openedx-edly-discussion plugin, and includes guides for developers.

Compatibility

openedx-edly-discussion supports:

• Open edX (hawthorn or later)
• NodeBB (v1.10.x or above)
• nodebb-plugin-openedx-discussion (v0.1.0 or newer)

How To Contribute

To contribute, please make a pull request in this repositry on Github: openedx-edly-discussion. If you have any questions or issues, please feel free to create an issue.

Contributors

• Muhammad Zeeshan
• Osama Arshad
• Danial Malik
• Hamza Farooq
• Muhammad Umar Khan
• Tehreem Sadat
• Hassan Tariq

---