Project learnSpire

Project learnSpire is a fully functional learning management system including microservices architectured API backend, Android application and single-page React website.

This is the main backend microservice called learning management system. This service can use to handle courses, content, enrollments, marks and announcement.

Handle users, registrations and login we have another microservice called user management system. You can check it here.

Architecture and Database Diagrams

• Context Diagram: https://bit.ly/3a3prOO

• Container Diagram: https://bit.ly/3lu76wP

• Component Diagram: https://bit.ly/3sNY3eo

• Database ER Diagram: https://bit.ly/3wyPuWV

Features

• We added spring in-memory caching and increased the performance by 40%.

• We added multi-threading to the email service and increased the performance by 70%.

• All of the backend services are unit tested to ensure that nothing goes wrong in any situation.

• All the endpoints are integration tested to ensure that all functionalities work as intended.

Getting Started

We pushed this application's Docker image to the Docker hub. To run the application you need to setup Docker in your pc properly. Then you can follow the steps.

1. Pull the Docker image from the Docker hub.

docker pull krishanshamod/learning-management-system

2. Create a file called docker-compose.yml and add following content to it.

services:
    lms:
        image: "krishanshamod/learning-management-system"
        ports:
            - 8080:8080
        environment:
            - lms_db_url= [database url]
            - lms_db_username= [database username]
            - lms_db_password= [your database password]
            - token_secret= [jwt token secret]
            - mailgun_domain= [mailgun domain]
            - mailgun_api_key= [mailgun api key]
            - email_sending_domain= [email sending domain]

Note: You need you replace the environment variables with your own values. If you wish to use the localhost database then you need to replace the ports array lines with the following.

network_mode: host

3. Locate to the docker-compose.yml file directory using terminal and execute this command.

docker-compose up -d

Now you are good to go. Learning management system is running on port 8080.

You can also run this application as a normal Java application. You can clone the repo, build using maven, put the environment variables and then you can run the jar file as normal java application.