Transkribus Client for eXist-DB
-
exist-db version:
5.3
or greater -
ant version:
1.10.12
(for building from source) -
node version:
14.x
(for building from source)
-
Download the
Transkribus-eXist-0.1.0.xar
file from GitHub releases page. -
Open the dashboard of your eXist-db instance and click on
package manager
.- Click on the
add package
symbol in the upper left corner and select the.xar
file you just downloaded.
- Click on the
-
You have successfully installed Transkribus-eXist into exist.
-
Download, fork or clone this GitHub repository
-
There are two default build targets in
build.xml
:-
dev
including all files from the source folder including those with potentially sensitive information. -
deploy
is the official release. It excludes files necessary for development but that have no effect upon deployment.
-
-
Calling
ant
in your CLI will build both files:
cd Transkribus-eXist
ant
- to only build a specific target call either
dev
ordeploy
like this:
ant dev
If you see BUILD SUCCESSFUL
ant has generated a Transkribus-eXist-0.1.0.xar
file in the build/
folder. To install it, follow the instructions above.
To run tests locally your app needs to be installed in a running exist-db instance at the default port 8080
and with the default dba user admin
with the default empty password.
A quick way to set this up for docker users is to simply issue:
docker run -dit -p 8080:8080 existdb/existdb:release
After you finished installing the application, you can run the full testsuite locally.
This app uses mochajs as a test-runner. To run both xquery and javascript unit-tests type:
npm test
This app uses cypress for integration tests, just type:
npm run cypress
Alternatively, use npx:
npx cypress open
You can take a look at the Contribution guidelines for this project
MIT © Dario Kampkaspar