OCM Principal Manager

Description

The Principal Manager is the microservice responsible for handling the authentication and credential issuance for an individual PCM user.

Usage

Swagger Documentation:

Swagger/OpenAPI

Installation

Pre-requisite

• pnpm
• docker
• docker-compose
• Postgres

OCM Services Dependencies

• SSI Abstraction

Running the app

Each service in the Organizational Credential Manager can be run from the infrastructure repository with Docker.

The .env files are in the infrastructure repository under /env

    ## production in:
      ./deployment/ci
    ## development in:
      ./deployment/dev

• (optional) Edit docker-compose.yml in "infrastructure" to use either /ci/ or /dev/ Dockerfiles.

• Run while in "infrastructure" project:

$ docker-compose up --build attestation-m

to run only Attestation Manager or

$ docker-compose up --build

to run all the services.

Build

pnpm build

Run

pnpm start

Environment variable required

1. PORT
2. DATABASE_URL
3. ECSURL
4. NATS_URL
5. AGENT_URL

Outgoing communication services

1. CONNECTION MANAGER

Incoming communication services

1. ATTESTATION MANAGER

Features supported

1. Issue Membership credential

Test

# unit tests
$ pnpm test

# e2e tests
$ pnpm test:e2e

# test coverage
$ pnpm test:cov

GDPR

GDPR

Dependencies

Dependencies

License

Apache 2.0 license