# Quadroreader

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

## 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:

```json
{
  "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.

## 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:

```bash
> 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`.

## Facsimile

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

## Deployment

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

```bash
> make deploy
```

**Possible arguments**

* PORT: the port on which the application is running
* MONGOPORT: the port on which the application searches for the database

## 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:

```bash
> make docker
```

**Possible arguments**

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

```bash
> 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.

## Requirements

* make
* git
* nodejs
* mongodb
* curl
* imagemagick

## 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