Developer's Doc: How to set-up and use Discussions-UI library

This document will help to set up and use the Discussion-UI library.

Background:

Discussion-UI library is an angular base library that will help any platform to configure and use a discussion forum.

In the Sunbird use case, any of the learning sections can have a discussion forum attached to it like Courses, Groups, etc. This is being achieved by this library.

Git Repository:

https://github.com/Sunbird-Ed/discussions-UI

Peer dependencies:

Prerequisite:

  1. NodeBB: Local setup

  2. Discussion middleware: Local setup

Discussions-UI library local set-up:

Git clone the discussion-ui library:

> git clone git@github.com:Sunbird-Ed/discussions-UI.git > cd discussion-UI > yarn

Now change the configuration of library/application to communicate with local NodeBB & Discussion-middleware.

Note: Make sure Local discussion-middeware & NodeBB is running.

Open "url.config.ts" file Change the property "host" to local discussion-middleware setup => host: 'http://localhost:3002'

Build the discussion-UI library project. The build will get created in dist folder.

> ng build --watch=true

Now run the demo application