README.md 1.06 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

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

mrodzis's avatar
mrodzis committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

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

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

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

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

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

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

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

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

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


## Authors

See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.