README.md 1.57 KB
Newer Older
Mathias Goebel's avatar
Mathias Goebel committed
1
2
# Emo Viewer (viewer)

mrodzis's avatar
mrodzis committed
3
Viewer for the modular framework to present digital editions.
Mathias Goebel's avatar
Mathias Goebel committed
4

5
Demo: https://subugoe.pages.gwdg.de/emo/Qviewer/develop
Nils Windisch's avatar
MINOR    
Nils Windisch committed
6

7
(for newer branches the demo is deployed in a directory named with branch name lowercased, shortened to 63 bytes, and with everything except `0-9` and `a-z` replaced with `-` (CI_COMMIT_REF_SLUG). Also the commit short hash can be used to see a demo.
mrodzis's avatar
mrodzis committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

## Getting Started

### Prerequisites

To get the EMo Viewer up and running you should have the following software installed:

* npm
* vue-cli (globally installed)
* vue-cli-service-global (globally installed)

For using the development mode you also need
* quasar-cli (globally installed)

To get all dependencies via `npm`, simply run

```bash
npm install -g @vue/cli @vue/cli-service-global @quasar/cli
```

### Installing

### Get the Dependencies
31

Mathias Goebel's avatar
Mathias Goebel committed
32
33
34
35
```bash
npm install
```

mrodzis's avatar
mrodzis committed
36
### Start the App in Development Mode (Hot-Code Reloading, Error Reporting, etc.)
37

Mathias Goebel's avatar
Mathias Goebel committed
38
39
40
41
```bash
quasar dev
```

mrodzis's avatar
mrodzis committed
42
### Lint the Files
43

Mathias Goebel's avatar
Mathias Goebel committed
44
45
46
47
```bash
npm run lint
```

mrodzis's avatar
mrodzis committed
48
### Build the App for Production
49

Mathias Goebel's avatar
Mathias Goebel committed
50
51
52
53
```bash
quasar build
```

mrodzis's avatar
mrodzis committed
54
### Customize the Configuration
55

Mathias Goebel's avatar
Mathias Goebel committed
56
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
mrodzis's avatar
mrodzis committed
57
58
59
60
61


## Authors

See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
62
63
64
65
66
67
68

## Dockerfile
The dockerfile is used at GitLab CI. It needs to be updated, when either node or quasar-cli should be updated.
```
docker build --pull -t docker.gitlab.gwdg.de/subugoe/emo/qviewer/node . 
docker push docker.gitlab.gwdg.de/subugoe/emo/qviewer/node
```