SsiAmAccreditationUi

Table of contents

• Set Up
  • Required Dependencies
  • Required Environment Variables
  • Running the application locally
  • Building the application
  • Running the application locally
• Testing
  • Running the Unit Tests
• Code Quality
  • Code formatting
• Documentation

Set Up

Required Dependencies

• NodeJS 14.15

In order to run the application npm install needs to be called to install all other dependencies To fully test the functionality, the other components need to be started as well.

Required Environment Variables

Variable	Description
VERI_UI_CONTAINER_NAME	Accreditation UI docker container name parameter
VERI_UI_HOST	The host the UI will use
VERI_UI_PORT	The port the UI will use
VERIFICATION_CONTROLLER_BASE_URL	The base url of the Verification controller
KEYCLOAK_URL	The base url to the keycloak instance
KEYCLOAK_REALM	The realm configured in keycloak
KEYCLOAK_CLIENT_ID	The client id configured in keycloak
QR_CODE_BASE_URL	Should point to the verification controller host and port
LOCATION_ID	Location ID, for now set this to your expected location e.g. "Hamburg"
TERMINAL_ID	The checkin terminal ID

Building the application

To compile and package the application use the following command:

npm run build:prod

Running the application locally

If you want to run the application locally:

npm run start

Testing

Running the Unit Tests

The unit test can be run through your preferred IDE.

Suggested: VisualStudio Code

Alternatively the unit test can also be run using the following command:

npm run test

Coverage

The coverage report can be generated via this command:

npm run test:headless

Code Quality

Code formatting

Identical code formatting can be ensured via prettier.

npm run format

Alternatively you can use a pre-commit hook and use the prepared command:

npm run pre-commit

Documentation

To generate a documentation as html run:

npm run compodoc