management-portal documentation

Management Portal

License

Management Portal is an interface to manage resources registered in Maritime Identity Registry and Maritime Service Registry, which are core components of Maritime Connectivity Platform. The starting foundation of this project has been build from the ngx-admin from Akveo. This repository maintains a spin-off implementation of Management Portal under the Apache 2.0 License.

Live demo

You can experience a live demo from our public demonstrator environment.

Development

Installation

Install the project through:

npm install

Now it can be reached at http://localhost:4200.

Deployment

First, we would recommend to read the instruction of Angular deployment.

Deployment to GitHub Pages through Angular deploy command

You can deploy the Angular App to a GitHub pages through:

ng deploy --build-target=[%AngularBuildTarget] --repo=[%GitHubRepositoryURL] --cname=[%TargetURL]

build-target option needs to be a full name of buildTarget from "build", e.g., management-portal:build:test for test configuration.

The deployment is powered by angular-cli-ghpages.

Deployment to GitHub Pages through GitHub Action

You can also take our GitHub Action script to deploy your own management portal to GitHub Pages.

Configuration

There are examples of environment configuration in the 'src/environments' folder.

Configuration parameter covers:

  • production: boolean value of whether a build for production or not

  • staging: boolean value of whether a build for staging or not

  • irProvider: name of the MIR provider

  • irContact: contact of the MIR provider

  • irBasePath: url of MIR API

  • oidcBasePath: url of MIR OIDC (keycloak endpoint for the MCC testbed)

  • hasServiceRegistry: boolean value of whether the provider has service registry or not

  • srProvider: name of the MSR provider

  • srContact: contact of the MSR provider

  • srBasePath: url of MSR API

  • mpProvider: name of the Management Portal provider

  • mpContact: contact of the Management Portal provider

  • environmentTitle: title showing at the front page

  • termsOfUse: terms of use using in the registration

  • idpNamespace: identity provider short ID (IPID in MCP IDsec2 MCC Identity Management and Security; Identity Management) included in MCP MRN, e.g., 'mcc-test'

  • environmentName: environment name showing at the front page

Client generation for backend integration with MIR and MSR

The client for MIR and MSR was auto-generated from the corresponding swagger files with Swagger Editor.

Configurable interface through ColumnFor*.json file

The main idea of making the Management Portal configurable has done by JSON formulation of interface capability for each attribute.

We have ColumnForMenu.json and ColumnForCert.json as examples on how it depicts functional interfaces for MCP entities and certificate respectively.

Acknowledgement

This development is a part of the project titled “Development of Open Platform Technologies for Smart Maritime Safety and Industries” funded by the Korea Research Institute of Ships and Ocean Engineering (PES4070).

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details.

results matching ""

    No results matching ""