Commit 1b4c54b5 authored by mrodzis's avatar mrodzis 🌿
Browse files

docs(readme.md): add section about backend connection, add missing general sections

cf. #26
parent ecaf999d
Pipeline #138878 passed with stages
in 2 minutes and 29 seconds
......@@ -5,7 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.6] - 2020-06-09
### Added
- information in the README on how to establish a link between the Viewer and a backend.
- missing general README section about contributing and versioning.
## [0.0.5] - 2020-05-20
......
......@@ -6,7 +6,7 @@ Viewer for the modular framework to present digital editions.
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.
Demo: https://subugoe.pages.gwdg.de/emo/Qviewer/develop
Demo: <https://subugoe.pages.gwdg.de/emo/Qviewer/develop>
(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.
......@@ -61,11 +61,6 @@ quasar build
See [Configuring quasar.conf.js](https://quasar.dev/quasar-cli/quasar-conf-js).
## Authors
See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
Please notice our [contribution guidelines](CONTRIBUTING.md) which contains all necessary information about the development workflow.
## Dockerfile
The dockerfile is used at GitLab CI.
......@@ -75,3 +70,26 @@ 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
```
## Connecting the Viewer with a Backend
The viewer expects JSON that complies to the [SUB's generic TextAPI](https://subugoe.pages.gwdg.de/emo/text-api/) in order to function properly.
To establish a link to the backend, the viewer's entrypoint in `src/index.template.html` has to be modified:
```html
"entrypoint": "https://{server}{/prefix}/{collection}/collection.json"
```
The entrypoint should point to the collection you want to be displayed.
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](https://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/tags).
## Authors
See the list of [contributors](https://gitlab.gwdg.de/subugoe/emo/Qviewer/-/graphs/develop) who participated in this project.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment