Sunbird Admin Portal & Dashboard (V1.0)

[poojakarma]

Currently Sunbird does not support tenant creation, user creation etc.. via ui. So we have started building a UI for putting together all such tasks to benefit the community. Sharing the repo with the details .

Name: Sunbird Admin Portal & Dashboard
Version: 1.0

Currently Implemented features :

1. Organisation Dashboard -> Shows Organisations, Number of sub-Organisation, Number of User and Roles/content Information
   Display Shot:
   

2. Create and modify Organisation ,create Sub-Organisation
   Display Shot:
   

3. Create User in Organization and sub-Organization, Edit Role of User , Block/unblock user
   Display Shot:
   

4. User Dashboard -> Shows total users,and User list with filter feature
   Display Shot:
   

Features in pipeline :

1. Click and view reports (eg. Course reports)
2. Certificate Re-issue & Share
3. User Bulk Upload
4. Content bulk upload
5. KeyCloak Integration

Install and Setup
1) Prerequisites
Angular CLI: 15.2.6
Node 14.21.3
Npm 6.14.18
Authkey and User token of the SB instance that you want to connect / perform the admin tasks

2) Steps to Install
Step 1: fork from https://github.com/tekdi/sunbird-admin-ui.git here
Step 2: create new fork
Step 3: open VS code , open terminal and enter below command
Step 4: git clone https://github.com/your_repo_name/sunbird-admin.git (fork Url)
Step 5 : cd sunbird-admin
Step 6: git remote add upstream https://github.com/tekdi/sunbird-admin-ui.git (main git Url)
Step 7: git checkout -b “admin-Dashboard”
Step 8: git fetch upstream main
Step 9: git pull upstream main
Step 10 : npm i
Step 11: paste below code in environment.ts file and set authKey and userToken
Path : src -> environments -> environment.ts
export const environment = { production: false, port: "http://localhost:4200/", instance: "https://your-sunbird-instance.com/", apiUrl: "https://your-sunbird-instance.com/api", target: "https://your-sunbird-instance.com", addOrgUrl: "api/org/v1/create", orgUrl: "api/org/v1/search", userUrl: "api/user/v1/search", userCreateUrl: "api/user/v3/create", userUpdateRoleUrl: "api/user/v1/role/assign", blockUserUrl: "api/user/v1/block", unblockUserUrl: "api/user/v1/block", authKey: "", userToken: "", "expires_in": 21600, "refresh_expires_in": 21600, "refresh_token": "", };
Step 12: set url in proxy.conf.js file
"target": "https://your-sunbird-instance.com/"
// The sb instance that you want connect to perform these tasks`
Step 13 Run the command ng serve from the project directory
Step 14 Open the browser and type http://localhost/:4200

3. Important Configuration files

1. config->constant.config.ts (SystemRoles) : Users can easily extend SystemRoles by adding new system roles into SystemRoles Constant to efficiently control access and visibility within the system.
2. config->constant.config.ts (Roles) : Users can easily add more roles options to create user under particular role by adding in Roles constant

[Krishnaj20]

@poojakarma - thank you for sharing this contribution. We've always wanted someone from the community use the APIs to build and maintain the UI tools which can be of help to everyone in the community. Super glad to see this coming thru. Can we have a demo of this on 25th Sep?

@mohitga @vinukumar-vs @AmiableAnil

[poojakarma]

@Krishnaj20 Sir, Thank you for sharing the recording, and I'm glad you found the demo helpful. We'll definitely keep you updated on the progress of integrating the authentication layer.

[Krishnaj20]

@poojakarma @baljeetsingh - Any update on the ETA for this contribution please?

[poojakarma]

@Krishnaj20 Sir, Minor changes have been implemented that were discussed in meeting. We are now in the process of awaiting approval and merging. We'll update you on ETA and KeyCloak Integration after internal discussion with team.
@baljeetsingh Sir

[parthlawate]

@poojakarma @manojLondhe can you update on the status of this please ?

[mohitga]

@poojakarma can you update the status, let me know when can contribution will be ready for integration with Sunbird Ed.

cc: @parthlawate