Mojaloop Business Operations Framework Experience API

Introduction

This is an API for experience layer which is a part of the Business Operations Framework.

Runtime Configuration

Runtime configuration is handled by rc, and can be specified using either Environment Variables, or a .json file.

See ./config/default.json for an example config file.

When setting configuration using environment variables, the BOP_EXPERIENCE_API environment variable prefix is required.

For example to set a configuration variable 'ORY_KETO_READ_SERVICE_URL', we need to pass the environment variable like this BOP_EXPERIENCE_API_ORY_KETO_READ_SERVICE_URL.

See src/shared/config.ts to understand how these variables are configured.

Key Config Options

| Variable Name | Description | Default Value | | -------------------- | ----------- | ------ | | CENTRAL_ADMIN_URL | Central Admin Service URL | http://central-ledger:3001 | CENTRAL_SETTLEMENTS_URL | Central Settlements Service URL | http://central-settlements:3001

Note: See ./config/default.json for all available config options, and their default values.

Setup for developer

Clone repo

git clone [email protected]:mojaloop/reporting-hub-bop-experience-api-svc.git

Install service dependencies

cd reporting-hub-bop-experience-api-svc
npm ci

Run the service with NPM locally

npm run startDev