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
Architecture
Sunbird desktop runs on a platform called electron.
Sunbird Desktop
Sunbird Desktop UI
The Portal folder is responsible for rendering 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 folders
These are the important folders that are used in Sunbird Desktop:
This folder is used to provide the Authentication/Authorization session of the logged-in user.
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.
The main.ts file is the entry point of a portal desktop where all the script executions are initiated.
This folder contains API server proxy to communicate with the upstream server, such as routes, sdk db schema, logger, proxy-util, and telemetry helper.
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 be stored & 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.
It enables applications to store data locally while offline, then synchronize it with PouchDB and compatible servers when the application is back online, keeping the user's data in sync no matter where they next log in.
The folder includes the code to initiate the player and the portal UI in the desktop app.
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 folders:
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 ecars if required on desktop.
Resources:
Last updated
