3.5.1. Quadroreader

The Quadroreader allows the user to present a set of facsimile in the web browser.

3.5.1.1. Configuration

To set some needed variable to a config file, you must run the command make config. If you call it without arguments, rhe result JSON file will look like this:

{
  "DATABASE" : "wittreader",
  "FACSIMILE_SUBDIR" : "wittgenstein",
  "MONGO_PORT" : "27017",
  "SEARCH_HOST" : "127.0.0.1",
  "SEARCH_PORT" : "10101"
}

If you wish to set for example another database name to use, run the command with argument: make DATABASE=xyz config

Like this you can set all of the five variables.

3.5.1.2. Import of the data into the database

To import all of the needed data (the coordinates and the transcriptions) to the database, you can use these commands:

> make database-insert (to insert both)
> make coordinates-insert (to insert just the coordinates)
> make transcription-insert (to insert just the transcriptions)

If you set the database name in the configuration step, you have to give the same name also to the target database-insert - for example: make DATABASE=xyz database-insert.

NOTE: you need to have the transcriptions in a folder in the main directory named transcription.

3.5.1.3. Facsimile

To see the facsimile in the viewer, you need to have the facsimile in a folder in the main directory named facsimile.

3.5.1.4. Deployment

To deploy the application on your system, just start this command:

> make deploy

Possible arguments

  • PORT: the port on which the application is running

  • MONGOPORT: the port on which the application searches for the database

3.5.1.5. Docker deployment

There is also the possibility to deploy the application inside a docker container. For this reason you can find a Dockerfile in the main directory.

If you want to use this way of deployment, just use this command:

> make docker

Possible arguments

To have both the facsimile and the transcriptions available, you have to mount them in the following way:

> make FACSIMILE_MOUNT=absolute/path/to/the/facsimile TRANSCRIPTION_MOUNT=absolute/path/to/the/xml-files docker

The deployment process is automatically started, when the container is ready.

3.5.1.6. Requirements

  • make

  • git

  • nodejs

  • mongodb

  • curl

  • imagemagick

3.5.1.7. Contact (Bugs, Feedback, Contribution and more)

For questions about Quadroreader just contact the current maintainer: Matthias Lindinger at the Bayerischen Staatsbiliothek München.

##License

WTFPL