README.md 1.97 KB
Newer Older
1
# EMo Viewer
Mathias Goebel's avatar
Mathias Goebel committed
2

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

5
6
7
8
**Note:**
Although the EMo Viewer is designed as a generic viewer for digital editions, it is currently developed within the scope of the [Ahiqar project](https://gitlab.gwdg.de/subugoe/ahiqar).
This is the reason for "Ahiqar" being mentioned several times in the docs of this repo.

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

11
12
(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
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

## 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
36

Mathias Goebel's avatar
Mathias Goebel committed
37
38
39
40
```bash
npm install
```

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

Mathias Goebel's avatar
Mathias Goebel committed
43
44
45
46
```bash
quasar dev
```

mrodzis's avatar
mrodzis committed
47
### Lint the Files
48

Mathias Goebel's avatar
Mathias Goebel committed
49
50
51
52
```bash
npm run lint
```

mrodzis's avatar
mrodzis committed
53
### Build the App for Production
54

Mathias Goebel's avatar
Mathias Goebel committed
55
56
57
58
```bash
quasar build
```

mrodzis's avatar
mrodzis committed
59
### Customize the Configuration
60

Mathias Goebel's avatar
Mathias Goebel committed
61
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
mrodzis's avatar
mrodzis committed
62
63
64
65
66


## Authors

See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
67
Please notice our [contribution guidelines](CONTRIBUTING.md) which contains all necessary information about the development workflow.
68
69

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