Mentor Service

CircleCI insights

develop

The Mentor building block enables effective mentoring interactions between mentors and mentees. The capability aims to create a transparent eco-system to learn, connect, solve, and share within communities. Mentor is an open source mentoring application that facilitates peer learning and professional development by creating a community of mentors and mentees.

System Requirements

• Operating System: Ubuntu 22/Windows 11/macos 12
• Node.js®: v20
• PostgreSQL: 16
• Apache Kafka®: 3.5.0

Service Setup Options

Elevate services can be set up locally using one of the following methods:

1. Using Dockerized Services and Dependencies

Set up the service quickly using Docker and Docker Compose. This approach simplifies the installation process by containerizing all services and their dependencies.

➡️ Follow the Dockerized Setup Guide

2. Using Natively Installed Services and Dependencies

Manually install all services and dependencies on your local machine for more granular control and customization.

➡️ Follow the Native Setup Guide

BigBlueButton™ Service (Optional) can be setup using the following method:

Setting up the BigBlueButton Service (Optional)

Setting up the BigBlueButton Service (Optional)

Installation

Expectation: Integrate the BigBlueButton meeting platform with the mentoring application.

1. Before installing, ensure that you meet all the prerequisites required to install BigBlueButton. To learn more, see Administration section in BigBlueButton Docs.

2. Install BigBlueButton version 2.6 using the hostname and email address, which you want to use. To learn more, see Administration section in BigBlueButton Docs.

3. After completing the installation, check the status of your server using the following command:

   sudo bbb-conf --check
   

   Note: If you encounter any error which is flagged as Potential problems, check for installation or configuration errors on your server.

4. Start the service using the following command:

   sudo bbb-conf --start
   

5. Check if the BigBlueButton service is running using the following command:

   sudo bbb-conf --status
   

6. Restart the BigBlueButton server using the following command:

   sudo bbb-conf --restart
   

Obtaining the Secret Key

If you wish to generate a new secret key, use the following command:

sudo bbb-conf --secret

Deleting the Demo Meeting

If you want to delete the demo meeting, use the following command:

sudo apt-get purge bbb-demo

Tip:

• To learn more, see the Administration section in BigBlueButton Docs.
• To automatically delete the metadata of recordings which are converted to mp4 format and uploaded on the cloud storage, see ELEVATE-Project on GitHub.

Postman Collections

• Mentoring Service
• User Service
• Notification Service
• Scheduler Service

Dependencies

This project relies on the following services:

• User Service
• Notification Service
• Scheduler Service
• Interface Service

Please follow the setup guide provided with each service to ensure proper configuration. While these are the recommended services, feel free to utilize any alternative microservices that better suit your project's requirements.

For a comprehensive overview of the MentorEd implementation, refer to the MentorEd Documentation.

The source code for the frontend/mobile application can be found in its respective GitHub repository.

Team

Open Source Dependencies

Several open source dependencies that have aided Mentoring's development: