sunbird-portal

---

What is Sunbird?

Sunbird is a next-generation scalable open-source learning solution for teachers and tutors. Built for the 21st century with state-of-the-art technology, Sunbird runs natively in cloud/mobile environments. The open-source governance of Sunbird allows a massive community of nation-builders to co-create and extend the solution in novel ways.

What is the project mission?

Project Sunbird has a mission to improve learning outcomes for 200 million children across India. This is a multi-dimensional problem unique to the multi-lingual offline population of India (and other developing countries). It's not a problem of any single organization or stakeholder and it cannot be realistically addressed by individual effort.

Project Sunbird is an open, iterative and collaborative approach to bring together the best minds in pursuit of this audacious goal.

What is the Sunbird portal?

The Sunbird portal is the browser-based interface for the Sunbird application stack. It provides a web-app through which all functionality of Sunbird can be accessed.

Getting started

To get started with the Sunbird portal, please try out our cloud-based demo site at: https://staging.open-sunbird.org/

Local Installation

You can also install the Sunbird portal locally on your laptop, please follow the instructions below: Have node version 10 and follow the next steps

Pre Installation Steps

Prerequisities

1. Node > 18x
2. Angular 1x
3. Yarn

Sunbird dev has 2 parts

	1. Angular client
	2. Node server

Go to src/app/helpers/ replace environmentVariablesHelper.js

Installing and running Angular client

Step 1: Go to src/app/client folder

yarn install
npm run start
# For Developer's local setup Run below command
./local_setup.sh
ng build --watch=true

Installing and running Node server

Step 2: Go to src/app folder

yarn install
npm run server

Reporting Issues

We have an open and active issue tracker. Please report any issues.

---

Installing Sunbird Portal

Installing Sunbird requires two primary software components:

• Sunbird portal or web application
• Sunbird services stack or the backend API interface

Table of contents

• Prerequisites
• Project Setup
• Running Application
• Project Structure
• Testing
• Dependencies List

---

Prerequisites

System Requirements
Operating System	Windows 7 and above/4.2 Mac OS X 10.0 and above/Linux
RAM	> 16 Gb (Minimum 8Gb)
CPU	2 cores, > 2 GHz

Software dependencies
Node	> 16.19.x (Install the latest release of LTS version)
Angular CLI	> 14.x.x (Install the latest Angular CLI version)
yarn	Latest version of yarn: npm install --global yarn
nodemon	Latest version of nodemon: npm install -g nodemon

Project Setup

1. Clone project

   git clone https://github.com/Sunbird-Ed/SunbirdEd-portal.git

   Note: Stable versions of the sunbird portal are available via tags for each release, and the master branch contains latest stable release. For latest stable release refer

2. Install required dependencies

   1. Sunbird portal or web application

      1. $ cd {PROJECT-FOLDER}/src/app/client
      2. $ yarn install

   2. Sunbird services stack or the backend API interface

      1. $ cd {PROJECT-FOLDER}/src/app
      2. $ yarn install

3. Configuring the Environment and Services Stack

   Configure the following system environment variables in the terminal which you have opened

      | Environment Variable      |  Value  | Data Type |
      | :------------------------ | ------- | --------- |
      |  sunbird_environment      | local   |   string  |
      |  sunbird_instance         | sunbird |   string  |
      |  sunbird_default_channel  | sunbird |   string  |
      |  sunbird_default_tenant   | sunbird |   string  |
   

   The initialization of these environmental variables can take place in a common place like in your .bashrc or .bash_profile

4. Edit the Application Configuration

   To configure your application for local development, rename the file example.env in /src/app folder to .env and enter the values of the following environment variables

      |       Environment Variable              |                   Description                                       |
      | :-------------------------------------- |---------------------------------------------------------------------|
      |  sunbird_default_token                  |   To set the Default Mandatory Token for Anonymous and Logged User  |
      |  cloud_private_storage_secret           |   To set the Cloud Account Key                                      |
      |  cloud_private_storage_accountname      |   To set the Cloud Private Storage Account Name                     |
      |  sunbird_cloud_storage_provider         |   To set the Cloud Storage Provider                                 |
      |  sb_domain                              |   To set the Environment of the Application                         |
   

   For further environment variable reference refer to this confluence wiki link: https://project-sunbird.atlassian.net/wiki/spaces/SP/pages/3353378817/Portal+-+Min+environment+variables

   Once the file is updated with appropriate values, then you can proceed with running the application

Running Application

1. Sunbird portal or web application

   1. Run the following command in the {PROJECT-FOLDER}/src/app/client folder
   2. $ ng build --watch=true
   3. Wait for the build process to complete before proceeding to the next step

2. Sunbird services stack or the backend API interface

   1. Run the following command in the {PROJECT-FOLDER}/src/app folder
   2. $ npm run local-server

3. The local HTTP server is launched at http://localhost:3000

Project Structure

.
├── Sunbirded-portal
|   ├── /.circleci                           #
│   |   └── config.yml                       # Circleci Configuration file
|   ├── /src/app                             # Sunbird portal or web application
│   |   ├── /client                          # -|-
│   |   |    └── src                         # -|-
│   |   ├── /helpers                         # Helpers and Service file
│   |   ├── /libs                            # Sunbird utilities
│   |   ├── /proxy                           # Redirection to respective services
│   |   ├── /resourcebundles                 # Language resources
│   |   ├── /routes                          # Sunbird Backend Routes
│   |   ├── /sunbird-plugins                 # Sunbird plugins for editors
│   |   ├── /tests                           # Test case scripts for helpers and routes
│   |   ├── framework.config.js              # Default framework configuration
│   |   ├── gulp-tenant.js                   # -|-
│   |   ├── gulpfile.js                      # Gulp build configuration
│   |   ├── package.json                     # Contains Node packages as specified as dependencies in package.json
│   |   └── server.js                        # Main application program file / entry file for Sunbird services stack or the backend API interface
└───└── .gitignore                           # git configuration to ignore some files and folder

Testing

1. Sunbird portal or web application

    1. $ cd {PROJECT-FOLDER}/src/app/client
    2. $ npm run test
    3. With Coverage $ npm run test-coverage
   

2. Sunbird services stack or the backend API interface

    1. $ cd {PROJECT-FOLDER}/src/app
    2. $ npm run backend-test
    3. With Coverage $ npm run backend-test-with-coverage
   

Dependencies list

Portal - Frontend

Plugin Name	Plugin Repository	npm version	NG Version
@project-sunbird/chatbot-client	https://github.com/project-sunbird/sunbird-bot-client	4.0.0	NG 13
@project-sunbird/common-consumption	https://github.com/Sunbird-Ed/SunbirdEd-consumption-ngcomponents	6.0.0	NG 13
@project-sunbird/common-form-elements-full	https://github.com/Sunbird-Ed/SunbirdEd-forms	6.0.0	NG 14
@project-sunbird/sb-content-section	https://github.com/Sunbird-Ed/sb-content-module	6.0.0	NG 13
@project-sunbird/sb-notification	https://github.com/Sunbird-Ed/sb-notification	6.0.0	NG 14
@shikshalokam/sl-questionnaire	https://github.com/shikshalokam/sl-questionnaire-components	2.3.0	NG 12
@shikshalokam/sl-reports-library	https://github.com/shikshalokam/sl-reports-library	3.0.1	NG 14

CI/CD Workflows

Docker Build and Push Workflow

This repository includes a GitHub Actions workflow to automate the process of building and pushing Docker images to a container registry.

Workflow Overview

The workflow is defined in .github/workflows/image-push.yml. It triggers on every push to a tag in the repository.

Key Features

• Builds the Docker image using the build.sh script.
• Supports multiple container registries:
  • Google Container Registry (GCR)
  • Azure Container Registry (ACR)
  • DockerHub Registry
  • GitHub Container Registry (GHCR)
• Automatically tags the Docker image with the Git tag and a short commit hash.

Prerequisites

Before running this workflow, ensure the following:

1. Secrets Configuration:

   • Add the required secrets based on the value passed to REGISTRY_PROVIDER variable: If no values are passed in variables and secrets the image will be pushed to GHCR.

     • For Google Container Registry (GCR):

       • REGISTRY_PROVIDER : gcp
       • GCP_SERVICE_ACCOUNT_KEY: Base64-encoded Google Cloud service account key.
       • REGISTRY_NAME: The registry name (e.g., asia-south1-docker.pkg.dev).
       • REGISTRY_URL: The full URL of the registry (e.g., <registry_name>/<project_id>/<artifact_name>).

     • For DockerHub Registries:

       • REGISTRY_PROVIDER : dockerhub
       • REGISTRY_NAME: The registry name (e.g., docker.io).
       • REGISTRY_URL: The full URL of the registry (e.g., docker.io/username).
       • REGISTRY_USERNAME and REGISTRY_PASSWORD: Credentials for the registry.

     • For Azure Container Registry (ACR):

       • REGISTRY_PROVIDER : azure
       • REGISTRY_NAME: The name of your Azure Container Registry (e.g., myregistry.azurecr.io).
       • REGISTRY_URL: The full URL of the registry(e.g., myregistry.azurecr.io)
       • REGISTRY_USERNAME: The username for your Azure Container Registry.
       • REGISTRY_PASSWORD: The password for your Azure Container Registry.

     • For GitHub Container Registry (GHCR):

       • GITHUB_TOKEN: Automatically available for GitHub Container Registry.

     Note: All variables and secrets must be configured in Settings → Secrets and variables → Actions in your GitHub repository.

Code Quality

The project maintains code quality through automated checks that run on every pull request:

1. Linting

   • Runs ESLint to check code style and quality
   • Command: yarn lint

2. Dependencies

   • Uses yarn install for deterministic installations
   • GitHub Actions cache for faster builds

3. Code Formatting

   • Ensures consistent code formatting
   • Can be automatically fixed using yarn lint:fix

4. Testing

   • Runs automated tests using 8 parallel shards for faster execution
   • Each shard runs a portion of the test suite
   • Tests are executed in the src/app/client directory
   • Command: yarn test:ci

These checks ensure consistent code style and secure dependency management.