RQZH2 Readme

Build rqzh2

• simply run the command ant in your terminal in the rqzh2 folder and install the data package (see below).

Data Package

This app uses data stored in the Github repository https://github.com/stazh/erqzh-data.
Clone the repository

git clone git@github.com:stazh/erqzh-data.git

build the xar file by running ant and install the data xar file.

Utilise Dev Version of pb-components

1. clone tei-publisher-components ( github.com/eeditiones/tei-publisher-components/ )
2. in rqzh2 modules/config.xqm set $config:webcomponents-cdn to ‘local’
3. call ant xar-local
4. remove tei-publisher-components from resources/scripts ( rm -rf resources/scripts/*.js )
5. in tei-publisher-components repo execute npm i && npm run build
6. copy generated .js and .map files from the tei-publisher-components ( e.g. cp dist/*.js dist/*.map $RQZH/rqzh2/resources/scripts/ )
7. call ant xar-local again

Run pb-components from feature branch

1. configure the branch / PR in package.json like this "@teipublisher/pb-components": "git+https://github.com/eeditiones/tei-publisher-components.git#develop"
2. in modules/config.xqm set config:webcomponents to local
3. call ant clean xar-local

Use local dev version of pb-components

1. clone tei-publisher-components ( github.com/eeditiones/tei-publisher-components/ ) or use your existing clone
2. in rqzh2 modules/config.xqm set $config:webcomponents :="dev";
3. in rqzh2 modules/config.xqm set $config:webcomponents-cdn to ‘http://localhost:8000’ (default port)
4. run npm i to load dependencies
5. run 'npm run start' to start the devserver which by default listens on port 8000
6. wait until server is running and start eXist-db with rqzh2

Testing

Inside /cypress/… you can find end-to-end tests for the deployed application, which is expected to run on localhost:8080. To execute the tests run either npm or npx command below:

npm run e2e
npx cypress run

To add new tests you might prefer the GUI overlay

npx cypress open

Select e2e test and then your preferred browser.