README.md 1.18 KB
Newer Older
mrodzis's avatar
mrodzis committed
1
# Ahiqar Frontend
Mathias Goebel's avatar
Mathias Goebel committed
2

3
4
The (static) frontend for the Ahiqar project: <https://ahikar.sub.uni.goettingen.de>

mrodzis's avatar
mrodzis committed
5
6
This repository mainly serves as a project specific customization of the EMo QViewer.
QViewer is integrated as git submodule.
7
8

It is integrated into the QViewer during the build of the backend, cf. <https://gitlab.gwdg.de/subugoe/ahiqar/backend#get-the-frontend>.
Mathias Goebel's avatar
Mathias Goebel committed
9
10

## Text Styling
mrodzis's avatar
mrodzis committed
11

mrodzis's avatar
mrodzis committed
12
13
14
15
To add a specific styling of the text in accordance with the project's requirements a
specific stylesheet, `ahikar.css`, is available.
The file is going to be included in the build of the QViewer application.
For local development copy the two files like shown below.
mrodzis's avatar
mrodzis committed
16
17

```bash
Mathias Goebel's avatar
Mathias Goebel committed
18
cp --force index.html Qviewer/src/index.template.html
Mathias Goebel's avatar
Mathias Goebel committed
19
cp --force ahikar.css Qviewer/src/statics/support.css
Mathias Goebel's avatar
Mathias Goebel committed
20
21
```

mrodzis's avatar
mrodzis committed
22
You do not have to track the copied files in the version control system.
Mathias Goebel's avatar
Mathias Goebel committed
23
24
25

## Auto-update

mrodzis's avatar
mrodzis committed
26
27
28
29
This submodule Qviewer will receive updates from its upstream project automatically.
The pipeline will be triggered by the upstream and passes the necessary upstream commit SHA.
For convinence we MAY add a manual job trigger in the upstream repository.
The upstream currently is: [subugoe/emo/Qviewer](https://gitlab.gwdg.de/subugoe/emo/Qviewer).