Skip to content
Snippets Groups Projects
README.md 1.16 KiB
Newer Older
Mathias Goebel's avatar
Mathias Goebel committed
# TextAPI Viewer
Mathias Goebel's avatar
Mathias Goebel committed
![pipeline badge](https://gitlab.gwdg.de/subugoe/emo/viewer/badges/master/pipeline.svg)
Mathias Goebel's avatar
Mathias Goebel committed
## Demo
https://subugoe.pages.gwdg.de/emo/viewer/

## Latest version
To embed the viewer in production the latest compiled and minified version is
available at https://gitlab.gwdg.de/subugoe/emo/viewer/-/jobs/artifacts/master/download?job=production

## Integration
To include the viewer on a website add the following to the html file:
```html
<noscript>
  <strong>We're sorry but TextViewer doesn't work properly without JavaScript
    enabled. Please enable it to continue.</strong>
</noscript>
<script id="emo-config" type="application/json">
{
  "manifest": "api/manifest.json"
}
</script>
<div id="viewer"></div>
<script src=js/chunk-vendors.[CHECKSUM].js></script>
<script src=js/app.[CHECKSUM].js></script>
```

and replace `[CHECKSUM]` with the values from the release you are going to use.

## Development

### Project setup
Mathias Goebel's avatar
Mathias Goebel committed
```
npm install
```

Mathias Goebel's avatar
Mathias Goebel committed
#### Compiles and hot-reloads for development
Mathias Goebel's avatar
Mathias Goebel committed
```
npm run serve
```

Mathias Goebel's avatar
Mathias Goebel committed
#### Compiles and minifies for production
Mathias Goebel's avatar
Mathias Goebel committed
```
npm run build
```

Mathias Goebel's avatar
Mathias Goebel committed
#### Run your tests
Mathias Goebel's avatar
Mathias Goebel committed
```
npm run test
```

Mathias Goebel's avatar
Mathias Goebel committed
#### Lints and fixes files
Mathias Goebel's avatar
Mathias Goebel committed
```
npm run lint
```