ALS Consent Oracle (Work in Progress)

Overview

• Documentation

Setup

Clone repo

git clone [email protected]:mojaloop/als-consent-oracle.git

Improve local DNS resolver

Add the 127.0.0.1 als-consent-oracle.local entry in your /etc/hosts so the als-consent-oracle is reachable on http://als-consent-oracle.local:3000. Elsewhere use http://localhost:3000

Install service dependencies

cd als-consent-oracle
npm ci

Run local dockerized als-consent-oracle

npm run docker:build
npm run docker:run

To check the als-consent-oracle health visit http://als-consent-oracle.local:3000/health

File structure of docker image

dist
│
└───config (Mount your default.json config file here)
└───migrations
└───seeds
└───src
└───package.json
logs
node_modules
package-lock.json
package.json (Run package commands with root package.json)

Run locally with database in docker-compose

docker-compose up -d mysql
npm run migrate
npm run start

Updating the OpenApi (Swagger) Spec

We use multi-file-swagger to make our swagger files more manageable.

After making changes to the .yaml files in ./src/interface/, update the swagger.json file like so:

    npm run build:openapi

Note: We will likely want to move to swagger 3.0 at some point, and once we do, we will be able to use the common api snippets library to factor out common Mojaloop snippets. Keep track of #352 - Update to OpenAPI v3

Auditing Dependencies

We use audit-ci along with npm audit to check dependencies for node vulnerabilities, and keep track of resolved dependencies with an audit-ci.jsonc file.

To start a new resolution process, run:

npm run audit:fix

You can then check to see if the CI will pass based on the current dependencies with:

npm run audit:check

The audit-ci.jsonc contains any audit-exceptions that cannot be fixed to ensure that CircleCI will build correctly.