role-assignment-service (Work in Progress)

API service for assigning roles and participants to users.

Overview

• Documentation

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 ROLE_ASSIGNMENT_SERVICE environment variable prefix is required. See src/shared/config.ts to understand how these variables are configured.

Key Config Options

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

Setup

Clone repo

git clone git@github.com:mojaloop/role-assignment-service.git

Improve local DNS resolver

Add the 127.0.0.1 role-assignment-service.local entry in your /etc/hosts so the role-assignment-service is reachable on http://role-assignment-service.local:3008. Elsewhere use http://localhost:3008

Install service dependencies

cd role-assignment-service
npm ci

Run local dockerized role-assignment-service

npm run docker:build
npm run docker:run

To check the role-assignment-service health visit http://role-assignment-service.local:3008/health