Reporting Hub BizOps Role Assignment Microfrontend

This is a microfrontend built to assign roles and participants to users.

It's built in React / Redux / Typescript and it includes some other libraries.

This project follows JAMStack architecture and attempts to follow it's best practices.

• Prerequisites
• Installation
• How to develop
• How to contribue
• How to deploy
• Configuration

Prerequisites

It requires node v16 to run, please make sure to have the correct version installed.

You can check your node version with node --version.

Note: you can use nvm to easily install and manage multiple node versions.

Installation

Before installing the project, please make sure you have read the prerequisites.

1. Install the dependencies with yarn install
2. Run the project with yarn start

At this point you can navigate with your browser to https://localhost:3001 to see the application running in the browser.

Note: depending on the configuration, you might be redirected to the login form of the authentication provider.

You are now ready to develop 🚀

How to develop

There are a number of rules that need to be followed to ensure good conding standards and keep the application structure compliant with the other Modusbox React applications.

Before starting writing code, make sure you follow the coding guidelines.

• Structuring the code
• Coding guidelines
• Available scripts and commands

For detailed instructions on what are the steps to follow when developing, please read the development steps page.

How to contribute

Everyone contributing to this project shall respect the contribution rules.

Security measures are applied to the repository so that it is protected from (some of) the bad practices.

For detailed instructions on how to contribute, please read the contribution rules page.

How to deploy

The app is configured to run in a docker image served by an embedded webserver; that makes it portable and convenient when has to run in a kuberneters environment.

For detailed instructions on the deployment process please read deploying to production.

For more about docker, please read the docker configuration page.

Configuration

All the dev tools are already pre-configured and everything should work out of the box.

For more details read configuring the tools.

• Microfrontend setup
• Configuring the tools
• Environment variables
• External API

Local Development

Run Services

Locally, with Docker

1. reporting-hub-bop-role-ui uses role-assignment-service for local development.

   git clone git@github.com:mojaloop/role-assignment-service.git
   cd role-assignment-service
   docker-compose up

2. localhost:3008 hosts the role-assignment-service localhost:9443 hosts the wso2is server localhost:4466 hosts keto's read port localhost:4467 hosts keto's write port localhost:3001 hosts the central-ledger service The microfrontend points towards the role-assignment-service on localhost:3008 using a variable set in .env

3. Start up the reporting-hub-bop-role-ui microfrontend using yarn start.