Component Diagram

The Sunbird Desktop is the offline-based interface that provides to access & distribution of digital content in areas where Internet connectivity is challenging.

Video on Desktop App

GitHub Repository

SunbirdEd-portal/src/desktop at master · Sunbird-Ed/SunbirdEd-portalGitHub

github repo

Architecture

Desktop Architecture

Sunbird desktop run on a platform called electron

Sunbird Desktop

Sunbird Desktop UI

The Portal folder is responsible to render the UI on the desktop.

Sunbird Desktop API Server

The Modules folder contains the API server proxy to communicate with the upstream server

Code Structure

Important folder

These are the important folder that is used in Sunbird Desktop

• helpers

• glupfile.js

• main.ts

• modules

• OpenRAP

• Public

• env.json

• openrap-sunbirded-plugin

helpers

The folder is used to provide the Authentication/Authorization session of the logged-in user.

glupfile.js

In the portal desktop Gulp is a task runner that uses Node.js as a platform. Gulp purely uses JavaScript code and helps to run front-end tasks and large-scale web applications. It builds system automated tasks like CSS and HTML minification, concatenating library files, and compiling the SASS files.

main.ts

main.ts file is the entry point of a portal desktop. where all the scripts execution initiate

modules

This folder contains API server proxy to communicate with the upstream server such as routes, sdk db schema, logger, proxy-util, telemetry helper

OpenRAP

OpenRAP is more like a repo, where we have a content database which is meant for desktop it's a standalone app that runs mainly offline first. in offline first certain items such as content items, and telemetry user data have to store & when the user log-in it's not online but it will give the data from the pouchdb.

OpenRAP is an open-source initiative to enable communities/stakeholders to easily build and deploy WiFI-enabled resource access points within their community.

pouchdb

It enables applications to store data locally while offline, then synchronize it with CouchDB and compatible servers when the application is back online, keeping the user's data in sync no matter where they next log in.

Public

The folder includes the code to initiate the player and the portal UI in the desktop app

env.json

It contains the env.json file which is responsible for storing the env variable such as token,baseurl, and id that is required in the Desktop from DevOps.

openrap-sunbirded-plugin

It contains the below folder

content: sample content to be used for offline desktop

Data: It contains some sample channels used as a default, sample form JSON, faq, framework & location.

ecars: it stands for ekstep content archive it stores and loads the ecras if required on desktop

Resources:

• Portal Desktop Application - Local Setup

• OpenRAP

• electron