|
|
@@ -1,4 +1,12 @@
|
|
|
-# report-viewer
|
|
|
+# JPlag Report Viewer
|
|
|
+
|
|
|
+The JPlag Report Viewer is a Vue 3 + Typescript standalone application that can be used to display the JSON files generated by the JPlag reporting. The application requires Node.js and npm to be installed on the system.
|
|
|
+
|
|
|
+Before the first run execute:
|
|
|
+
|
|
|
+- Install necessary dependencies by running `npm install` in the /report-viewer folder.
|
|
|
+- Start the application by running the `npm run serve` command in the /report-viewer folder.
|
|
|
+- The report viewer is now accessible in your browser under http://localhost:8080/JPlag/
|
|
|
|
|
|
## Project setup
|
|
|
```
|