Merge pull request #10 from shiva-beehyv/add-data-test-ids-and-respon…

…siveness

Update README.md

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Modular Open Source Identity Platform
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,19 +1,43 @@
-# inji-verify
-Repository host the source code, documentation, and other related files for the Inji Verify project.
+# Inji Verify
 
-# Project Setup - Development
+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.
+
+---
+
+# Installations:
 
 Prerequisites:
-* Node 18 - Can be installed using [nvm](https://github.com/nvm-sh/nvm). Run following command to install node
+Node 18 - Can be installed using [nvm](https://github.com/nvm-sh/nvm). Run following commands to install node
+
+```
+$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+$ nvm install 18
+```
+---
+
+# Folder Structure:
+
+* **helm:** folder contains helm charts required to deploy on K8S
 
-    ```curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash```
+* **inji-verify:** contains the source code and Dockerfile
 
-    ```nvm install 18```
+---
 
-Run following commands to start the application
+# Running the application:
 
-```npm install```
+* Run following commands to start the application:
 
-```npm start```
+```
+$ cd ./inji-verify
+$ npm install
+$ npm start
+```
+
 
+- Build and run Docker for a service:
+```
+$ docker build -t <dockerImageName>:<tag> .
+$ docker run -it -d -p 3000:3000 <dockerImageName>:<tag>
+```
 
+- Open URL http://localhost:3000

inji-verify/package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "@emotion/react": "^11.11.4",
     "@emotion/styled": "^11.11.5",
-    "@mosip/pixelpass": "^0.1.2",
+    "@mosip/pixelpass": "0.1.2",
     "@mui/icons-material": "^5.15.15",
     "@mui/material": "^5.15.14",
     "@mui/styled-engine": "^5.15.14",