Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

digicatapult/veritable-issuer

Repository files navigation

veritable-issuer

Deprecation Notice

This application was deprecated on March 14th 2024, there will be no further dependency or security updates.

Description

Front-end for a license Issuer ( FlyDesire ) in Veritable. Issuers can issue credentials that later can be approved by the Regulator.


Getting started

Follow the README in the demo repo to start the cloudagent and von-network.

To start the application, run:

npm run start

Testing

Framework - CYPRESS
There are two types of tests one for React component as per individual basis and integration for testing different flows. The idea is that component test will be triggered after update to branch excluding main and integration for release build or after it has been merged with main.

Before running any tests please make sure you have cypress environment variables present. By the default cypress will read all environment variables prefixed with CYPRESS_ which can be accessed using Cypress.env('VAR_NAME') method. The main reason why integration test was excluded from branch check is because we have a limit of auth0 request.

A list of variables currently used in this repo

CYPRESS_TEST_USERNAME='username' # Cypress.env('TEST_USERNAME')
CYPRESS_TEST_PASSWORD='password'

Run component tests -> npm t
Run integration tests -> npm run test:integration Plugins are configured in cyopress/plugins/ folder

  • Component tests
  • Integration
    • Will start as a service
    • Allows us to mock external endpoints

Local development using Cypress

Cypress can also be utilised in local development when you require other services you can mock out api responses and run under the watch flag.

npm run test:dev

TODO

  • - include integration tests as part of github checks

Interacting with the ACA Swagger API Layer directly

README


Connecting Using Custom Endpoint

To connect to a custom backend: when first opening the GUI, instead of clicking Switch to CustomEndpoint, select the Dev option, fill in the Custom Endpoint - UserDefined with your custom endpoint URL and hit Switch to Custom.


Folder Structure

All the React components / sub-components, in this project are developed using the folders-as-components methodology (this methodology is described in detail here NodeJsOrg article).

That means that every existing React component here has its own folder with an index.js file and the component itself. This makes importing components more elegant. In addition, certain components are grouped inside folders and sub-folders.