Reporting Hub BizOps Shell

This is the Shell application that accommodates BizOps microfrontends.

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 coding standards and keep the application structure compliant with the other Mojaloop 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 kubernetes 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 testing with Ory and Keycloak

• Run dependencies with the following command

docker compose --profile ory up -d

• Wait for all the containers become healthy.
• Set a host recording in /etc/hosts file for keycloak

127.0.0.1 keycloak

• Add a user in keycloak using admin console
  • Open the URL http://127.0.0.1:8080/ (Administration Console)
  • Login with admin and admin
  • Select realm test-realm on top left
  • Go to users and create a new user by entering the following details
    • Username
    • Email
    • First name
    • Last name
    • Password in credentials
• Run application using yarn run start
• Open browser on http://127.0.0.1:3010/ (Note: do not use localhost due to some issues with redirection and cookies)
• It redirects to the keycloak login page
• Login with the new user created
• Then it should return back to the portal

Local testing without Ory and Keycloak

• Edit docker-compose.yaml file
• Go to reporting-hub-bop-shell service and make sure the AUTH_ENABLED environmental variable is false:

AUTH_ENABLED=false

• Edit the .env file
• Make sure the REACT_APP_AUTH_ENABLED variable is false:

REACT_APP_AUTH_ENABLED=false

Run dependencies with the following command

docker compose --profile ory up -d

• Wait for all the containers become healthy.