Sunbird RC
v2.0.0
v2.0.0
  • Learn
    • Introduction
    • Sunbird RC Overview
      • Why do we need Sunbird RC?
      • Core Capabilities
      • Core Registry Verbs
      • Workflows
      • What Sunbird RC is and what it's not? (WIP)
      • Possibilities
      • Demo Links
    • Technical Overview
      • Registry
        • High-Level architecture
        • Technical Specification Draft
        • Tech Stack and Requirements
      • Credentialling
        • High-Level Architecture
        • Technical Specification Draft
        • Tech Stack and Requirements
    • Adopters
    • Roadmap
  • Use
    • Getting started
      • Pre-requisites
      • Install Sunbird-RC
    • Developer's Guide
      • Functional Registry
        • Installation Guide
          • Registry CLI
            • Setup A Registry Instance
          • Manual installation through docker-compose
          • Production setup through Helm
        • Working with Source Code
        • Configurations
          • Frontend Configurations
          • Frontend - Proxy configuration
          • Audit Configuration
          • Notifications Configuration
          • View Templates Configuration
        • Schema Setup
          • Introduction To Schemas
          • Creating Your Own Schemas
          • Schema Configuration
          • Create Schemas With Custom Password
        • Setup the Backend
        • Setup the Frontend
        • Backup and Restore
          • PostgreSQL
            • SQL Dump
            • File System Level Backup
            • Continuous Archiving and Point-in-Time Recovery (PITR)
          • Cassandra
            • Snapshot-based backup method
            • Incremental backup method
            • Data Restore
        • Generic Identity And Access Management
        • Metrics
        • Custom Keycloak Build
        • Custom QR Code design
        • VC Verification Module
      • Credentialling Services
        • Installation Guide
          • Run for development
          • Docker compose based
          • Helm based
        • Configurations
        • Working with the Vault
    • Integrations
      • SSO with existing systems
      • Digilocker Meripehchaan SSO
      • Digilocker Integration
    • Connectors
      • G2P Connect
      • Open ID for Verifiable Credentials (OID4VCI)
    • Release Notes
      • Registry
      • Credentialling
    • Admin Portal
      • Login
      • Get Started
        • Create Schema
        • Attestation Workflows (WIP)
        • VC Template
          • Custom VC Template (WIP)
        • Ownership (WIP)
        • Publish (WIP)
      • Dashboard
  • API Reference
    • Registry APIs
      • Registry
        • Using The APIs
        • Create An Entity
        • Invite An Entity
        • Generate token
        • Generate admin token
        • Get An Entity
        • Get An Entity By Id
        • Update An Entity
        • Create A Property Of An Entity
        • Update A Property Of An Entity
        • Revoke a Credential
        • Delete An Entity
      • Schema
        • Create Schema
        • Get Schema
        • Update Schema
        • Delete Schema
        • Publish A Schema
      • Attestation API
        • Raise An Attestation
        • Get Attestation Certificate
      • Claims API
        • Get All Claims
        • Get Claim by ID
        • Attest A Claim
      • Discovery API
        • Search An Entity
      • File Storage API
        • Upload A File
        • Get Uploaded File
        • Delete A File/ Multiple Files
      • Metrics APIs
        • Get Count
        • Get Aggregates
    • Credentialling APIs
      • Identity Service APIs
      • Credential Schema APIs
      • Credential Issuance APIs
    • Other APIs
      • Sign API
      • Verify API
      • Swagger JSON API
      • Health API
  • Reference Solutions for Functional Registries
    • Education
      • Education Ecosystem
        • Installation
      • Education Registries
        • Installation
        • User Guide
    • Health Registries
      • Organ Registries
        • Frontend Setup
        • Backend Setup
        • User Guide
      • Health Facility Registry
    • Govt to Person (G2P)
  • Reference Solutions for Digital Credentials
    • Certificate Issuance
      • Installation(WIP)
      • User Guide
    • eLocker
      • High Level Diagram
      • Installation (WIP)
        • Frontend Setup E-locker
      • User Guide
    • Vaccination Platform
    • Skills & Work Credentials
    • Unified Learners Passport (ULP)
      • ULP Capabilities
      • Example Scenario
      • Technical Components (WIP)
      • Demo/Sandbox Links (WIP)
      • Installation Guide (WIP)
        • Frontend Setup
        • Installation through docker-compose
        • Dummy records setup for refrence
  • Links
    • Source Code
    • Releases & Changelogs
    • Website
    • Roadmap
    • Reference links
    • Design
  • Community
    • Discussion Forum
    • Contributors
    • Contributing
    • Contribution Guidebook
    • Code of Conduct
    • Community Events
    • Status By Track
  • HELP
    • Roadmap
    • FAQs
    • Glossary
    • Guide to Electronic Registries and Verifiable Credentials
      • Verifiable Credentials
        • What issues will Verifiable Credentials address?
        • What are the key roles in Verifiable Credentials?
        • What are the components of Verifiable Credentials?
        • What are the benefits of Verifiable Credentials?
        • Digital Credentials vs Verifiable Credentials
        • QR code vs Verifiable QR code
        • Use Cases
      • Electronic Registries
        • Evolution of Electronic Registries
        • What issues will Electronic Registries address?
        • Benefits of Electronic Registries
        • Registry vs Database
        • Design Principles
        • Use Cases
      • Leveraging Existing data stores
    • External Open Source Software Attributions
Powered by GitBook

Copyright (c) 2023 EkStep Foundation under MIT License

On this page
  • Backend Setup
  • Source Code
  • Project link
  • Frontend Setup
  • Prerequisite:
  • Proxy configuration (How to fix CORS issues)
Edit on GitHub
  1. Reference Solutions for Digital Credentials
  2. Certificate Issuance

Installation(WIP)

PreviousCertificate IssuanceNextUser Guide

Last updated 1 year ago

Backend Setup

Source Code

The source code to install this example can be found at

Project link

Frontend Setup

Prerequisite:

For Issuance portal two repos need to be setup

To set up Issuance on your local machine these steps should followed :

  1. Navigate to these repositories and create a fork

  1. Use these commands to clone the repositories

git clone https://github.com/Sunbird-RC/sunbird-rc-issuance-ui 
git clone https://github.com/Sunbird-RC/demo-certificate-issuance
cd demo-certificate-issuance/ui-config
  • In this folder you will see a list of JSON files. We need to create a symbolic link of these files in the assets folder of sunbird-rc-issuance-ui repository.

  • For this: copy the path of ui-config folder and navigate to assets/config folder of sunbird-rc-issuance-ui

  • Create a symbolic link

cd sunbird-rc-issuance-ui/src/assets/config/
ln -s <path_of_ui_config_from_edu_core_registries>

For example: ln -s /home/user/Issuance/demo-certificate-issuance/ui-config

demo-certificate-issuance

  • Navigate to the src folder of sunbird-rc-issuance-ui

  • Install dependencies and run the application using these commands

cd sunbird-rc-issuance-ui/src/
Nvm use v16.13.1
yarn
npm start

Proxy configuration (How to fix CORS issues)

To avoid CORS issues you can use proxy configuration.

Step 1 Firstly check a proxy.conf.json file in the root folder.

Step 2 Now we have to create the proxy configuration for API endpoints. So add your proxy configuration in your proxy.conf.json file as given in the below format-

"/registry/api/docs": {
"target": "https://domainname/",
"secure": false,
"changeOrigin": true,
"logLevel": "debug"
}

Definition of parameters is given below-

"/echo” is your API Path. "target" is your domain name where your API’s are hosted. "secure" is a boolean type parameter, if your domain has SSL then you should use true else you should use false as value. "changeOrigin" should be true if your backend is not hosted on localhost server. “logLevel" is used to check whether a proxy is working or not. Proxy log levels are info (the default), debug, warn, error, and silent.

Step 3: Now finally we have to replace the domain name with http://localhost:4200/ from the config.json file. And Run npm start or ng serve --proxy-config proxy.conf.json.

Angular 10.2.1 - find more information here

Make sure your node and npm versions are - node v16.13.1 (npm v8.1.2).You can also manage these versions using

- which contains the main project

- which contains reference ui config files

Clone repository and navigate to ui-config folder

https://angular.io/guide/setup-local
Node Version Manager
Sunbird-rc-issuance-ui
Demo-certificate-issuance
demo-certificate-issuance
LogoGitHub - Sunbird-RC/demo-certificate-issuanceGitHub
LogoGitHub - Sunbird-RC/demo-certificate-issuanceGitHub
LogoCertificate Issuance Use case • Sunbird-RCGitHub
LogoGitHub - Sunbird-RC/sunbird-rc-issuance-uiGitHub