akramer/digital-credentials-public-validator
akramer/digital-credentials-public-validator
0
0
Fork 0
Code Issues Pull Requests Activity

Added installation and run documentation

Browse Source
This commit is contained in:
Xavi Aracil 2023-10-10 11:36:24 +02:00
parent e0a901e5c7
commit 1e5fd236f3
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,6 +10,18 @@ This is primarily a validator for Open Badges 3.0 and Comprehensive Learner Reco
## User Documentation ## User Documentation
### Requirements
- Java installed (tested with Java 17)
- Maven installed (tested with Maven 3.8.6)
### Installation & Run
Navigate to main folder and run `mvn clean verify`. There's no need to install the packages in your repository.
Run the webapp by navigate to the `inspector-vc-web` folder and run `mvn spring-boot:run`
### Usage
Run the webapp in the module `inspector-vc-web` and open a browser into `http://localhost:8080`. Once in the main page, select which validator to run from the list and provide your artifact / uri to validate. Run the webapp in the module `inspector-vc-web` and open a browser into `http://localhost:8080`. Once in the main page, select which validator to run from the list and provide your artifact / uri to validate.
If you want to use the validator via API, point the browser to `http://localhost:8080/swagger-ui.html` for more documentation about the API. If you want to use the validator via API, point the browser to `http://localhost:8080/swagger-ui.html` for more documentation about the API.