From a52b9d73e6484e533e748c3b81ac4e4ca5b41807 Mon Sep 17 00:00:00 2001
From: jfrer <76432831+jfrer@users.noreply.github.com>
Date: Wed, 24 Jul 2024 10:48:23 +0200
Subject: [PATCH 1/4] docs: add a description and additional setup information
to readme (#98)
---
README.md | 39 ++++++++++++++++++++++++++++++---------
1 file changed, 30 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 4c648ee..cf862f5 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,57 @@
-# QUIVER
+# QuiVer Frontend
-This template should help get you started developing with Vue 3 in Vite.
+This is the frontend project for QuiVer. It's based on [Vue 3](https://vuejs.org/).
+QuiVer is an optical character recognition (OCR) benchmarking platform and part of the [OCR-D Project](https://ocr-d.de).
+This tool has a workflow view, which helps OCR-D users decide which workflow to use for their data by visualising metrics for predefined ground truth datasets.
+It also has a project view where OCR-D developers can get an overview of the projects and their status for each release.
-## Customize configuration
+It can be found under .
-See [Vite Configuration Reference](https://vitejs.dev/config/).
+See also [QuiVer Benchmarks](https://github.com/OCR-D/quiver-benchmarks/) for more information about the benchmarking.
-## Project Setup
+## Setup
+
+Requires node version 16 or higher.
+
+Install dependencies:
```sh
npm install
```
-### Compile and Hot-Reload for Development
+### Development
+
+Compile and run with hot-reload:
```sh
npm run dev
```
-### Compile and Minify for Production
+Access under `http://localhost:5173/quiver-frontend/`
+
+### Production
+
+Compile and minify for production:
```sh
npm run build
```
-### Lint with [ESLint](https://eslint.org/)
+Preview the production build:
+
+```sh
+npm run preview
+```
+
+### Linting
+
+We use [ESLint](https://eslint.org/) for linting. Check your code with:
```sh
npm run lint
```
-## Project Setup with Docker
+## Setup with Docker
Build the Docker image:
From c9d009d88fd41dc54ec58eb09e750a10c188b484 Mon Sep 17 00:00:00 2001
From: jfrer <76432831+jfrer@users.noreply.github.com>
Date: Wed, 24 Jul 2024 10:49:27 +0200
Subject: [PATCH 2/4] fix: resolve vue warnings (#95)
* fix: make showTextColors Prop optional
* wrap charts and overlaypanels in div to allow props to be inherited by a single root element
* fix: remove translations lookup from processor labels as they currently dont need translation
* fix: remove old i-icon, improve tooltip structure
* fix: add i18n details key to en
* fix: typo in script-type key in i18n de
---
src/components/workflows/TrendLegend.vue | 2 +-
src/components/workflows/WorkflowsTable.vue | 11 ++--
.../workflows/timeline/MetricAverageChart.vue | 66 ++++++++++---------
.../workflows/timeline/MetricChart.vue | 66 ++++++++++---------
.../workflows/timeline/TimelineFilters.vue | 2 +-
src/locales/de.json | 2 +-
src/locales/en.json | 1 +
7 files changed, 79 insertions(+), 71 deletions(-)
diff --git a/src/components/workflows/TrendLegend.vue b/src/components/workflows/TrendLegend.vue
index 4cf71bb..80ddcce 100644
--- a/src/components/workflows/TrendLegend.vue
+++ b/src/components/workflows/TrendLegend.vue
@@ -1,6 +1,6 @@
-