Skip to content

Repository host the source code, documentation, and other related files for the Inji Verify project.

License

Notifications You must be signed in to change notification settings

mosip/inji-verify

Repository files navigation

Quality Gate Status

Inji Verify

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.

Contents:

This document contains the following sections:

  • Installations
  • Folder Structure
  • Developer Setup
  • Demo Setup

Installations:

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
  • Maven

Folder Structure:

Once the repo is cloned, following folders can be found under the inji-verify repository folder:

  • api-test: contains the API automation tests
  • db_scripts: contains the database scripts for the Inji Verify application
    • sql (contains SQL scripts for database operations)
    • Readme.md
  • db_upgrade_script: contains the database upgrade and rollback scripts
    • sql (contains SQL scripts for database upgrade and rollback)
    • Readme.md
  • deploy: folder contains deployment scripts required to deploy on K8S
  • docker-compose : folder containing setup for docker compose
    • config
    • db-init
    • docker-compose.yml
    • Readme.md
  • docs : contains the flow, OpenAPI documentation for the Inji Verify application
  • helm: folder contains helm charts required to deploy on K8S
  • inji-verify-sdk: contains the Inji Verify SDK
  • ui-test: contains the ui automation tests
  • utilities: folder contains sample QR code variation generation utility for testing
  • verify-service: contains source code for the verify backend service
  • verify-ui: contains the application source code for web UI, Dockerfile and docker-compose.yml files

Developer Setup:

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

Development server:

To get a development server up and running, run the following commands:

mvn clean
mvn spring-boot:run

Run Docker Image:

(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>

Inji verify backend is designed to run in local with in memory H2 DB also we have another spring profile to do same. This can be controlled by passing active_profile_env environment variable while building the docker image

mvn -U -B package
docker build --build-arg active_profile=local -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

Demo Setup:

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.8.x
  • release-0.9.x
  • release-0.10.x
  • release-0.11.x
  • release-0.12.x
  • release-0.13.x
  • release-0.14.x

tags :

  • v0.14.0
  • v0.13.0
  • v0.12.3
  • v0.11.1
  • v0.11.0
  • v0.10.0
  • v0.9.0
  • v0.8.1
  • v0.8.0

active branches:

  • master
  • develop
cd ./inji-verify # repository folder
git checkout branchName/tagname # choose from any of the above branches

About

Repository host the source code, documentation, and other related files for the Inji Verify project.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 29