Injiverify is a web interface to verify the validity of the QR / credential using a browser from smartphone / tablet / computer. A user should be able to do primariliy 4 key actions - Scan, Validate, Fetch, Display.
This document contains the following sections:
- Installations
- Folder Structure
- Developer Setup
- Demo Setup
Prerequisites:
-
JAVA 21
Can be installed using sdkman. Run following commands to install node
$ curl -s "https://get.sdkman.io" | bash $ sdk install java 21.0.5-tem
Once the repo is cloned, following folders can be found under the inji-verify repository folder:
- deploy: folder contains deployment scripts required to deploy on K8S
- helm: folder contains helm charts required to deploy on K8S
- samples: folder contains sample QR codes for testing
- ui: contains the application source code for web UI, Dockerfile and docker-compose.yml files
- src (source code)
- Dockerfile
- docker-compose.yml
- Readme.md
- ui-test: contains the ui automation tests
- verify-service: contains source code for the verify backend service
- verify-service-bom: contains BOM for the verify backend service dependencies
Once the repo is cloned, move into the inji-verify repository folder and run the following command to check out to the develop branch:
cd inji-verify # move into the repository folder
git checkout develop
To get a development server up and running, run the following commands:
mvn clean
mvn spring-boot:run
(Note: Make sure that the following commands are run in the directory where Dockerfile is present)
Run the following commands to build and test the application as docker images
mvn -U -B package
docker build -t <dockerImageName>:<tag> .
docker run -it -d -p 3000:8000 --env-file ./.env --name inji-verify-service-dev <dockerImageName>:<tag>
To build the Docker image locally, use the following command. Ensure you are in the directory containing the Dockerfile:
docker build -t inji-verify-service:local
Stop and delete the docker containers using the following commands:
docker stop inji-verify-service-dev
docker rm inji-verify-service-dev
This section helps to quickly get started with a demo of the Inji Verify application
Once the repository is cloned, move into the inji-verify repository directory. Choose one of the branches that are currently available for the demo:
release branches:
- release-0.11.x
tags :
- v0.11.0
active branches:
- master
- develop
cd ./inji-verify # repository folder
git checkout branchName/tagname # choose from any of the above branches