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

mrodzis's avatar
mrodzis committed
3
This repository is a project specific customization of TIDO.
Michelle Weidling's avatar
Michelle Weidling committed
4
TIDO is integrated as git submodule.
5

mrodzis's avatar
mrodzis committed
6
7
The viewer can be reached at <https://ahikar.sub.uni.goettingen.de>.

mrodzis's avatar
mrodzis committed
8
It is integrated 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

mrodzis's avatar
mrodzis committed
10
11
12
13
## Project Configuration

The project specific configuration of the viewer is done in `index.html`. This file replaces TIDO's default settings in `index.template.html`. The replacement is done in the CI.

Mathias Goebel's avatar
Mathias Goebel committed
14
## Text Styling
mrodzis's avatar
mrodzis committed
15

mrodzis's avatar
mrodzis committed
16
17
To add a specific styling of the text in accordance with the project's requirements a
specific stylesheet, `ahikar.css`, is available.
Nils Windisch's avatar
Nils Windisch committed
18
The file is going to be included in the build of the TIDO application.
mrodzis's avatar
mrodzis committed
19
For local development copy the two files like shown below.
mrodzis's avatar
mrodzis committed
20
21

```bash
Nils Windisch's avatar
Nils Windisch committed
22
23
cp --force index.html tido/src/index.template.html
cp --force ahikar.css tido/src/statics/support.css
Mathias Goebel's avatar
Mathias Goebel committed
24
25
```

mrodzis's avatar
mrodzis committed
26
You do not have to track the copied files in the version control system.
Mathias Goebel's avatar
Mathias Goebel committed
27
28
29

## Auto-update

mrodzis's avatar
mrodzis committed
30
31
### Upstream

Nils Windisch's avatar
Nils Windisch committed
32
The submodule TIDO will receive updates from its upstream project automatically.
mrodzis's avatar
mrodzis committed
33
The pipeline will be triggered by the upstream after a merge on TIDO's `main` branch and passes the necessary upstream commit SHA.
mrodzis's avatar
mrodzis committed
34
For convinence we MAY add a manual job trigger in the upstream repository.
Nils Windisch's avatar
Nils Windisch committed
35
The upstream currently is: [subugoe/emo/tido](https://gitlab.gwdg.de/subugoe/emo/tido).
mrodzis's avatar
mrodzis committed
36
37
38
39
40
41

### Downstream

Each time a commit is done on `develop`, this repository's CI triggers a new pipeline on
the back end repository's `develop` branch so that the changes in the viewer are visible
shortly after.
mrodzis's avatar
mrodzis committed
42
43
The same holds for this repo's `main` branch which triggers the pipelines of the back end
basing on its `main` branch.