tobiasnx/format.gbv.de

Formatdatenbank

GBV-Formatdatenbank

Dieses Repository enthält den Quellcode und die Quelldaten der unter https://format.gbv.de/ zugänglichen Formatdatenbank.

Systemanforderungen

Erfordert mindestens PHP 7.4 mit Erweiterungen u.A. für XML.

$ sudo apt-get install php-xml php-mbstring php-curl

Weitere verwendeten PHP-Module werden mit Composer installiert:

$ composer install

Die Avram-Spezifikation und das dazu gehörige JSON Schema werden in einem eigenen repository verwaltet, dass bei der Installation automatisch neu geklont wird.

Quellcode

https://github.com/gbv/format.gbv.de

Zum Testen kann ein eigener Webserver erreichbar unter http://localhost:8021/ gestartet werden - allerdings funktioniert dabei die Auslieferung von Schema-Dateien nicht vollständig:

$ composer web

Installation

Create a user formatdb and check out the repository

$ sudo adduser formatdb --disabled-password --home /srv/formatdb
$ sudo -iu formatdb
$ git clone --bare https://github.com/gbv/format.gbv.de.git .git
$ git init; git checkout
$ composer install

Die Anwendung läuft mittels nginx und PHP-FPM. Zur Installation sind im Zweifellsfall beide zu Installieren und zu konfigurieren:

$ sudo apt-get install nginx php-fpm
$ sudo cp /srv/formatdb/format.gbv.de /etc/nginx/sites-enabled/format.gbv.de # ggf. anpassen
$ sudo service nginx restart

Development

Zur Sicherstellung, dass neue Einträge valide sind, muss zuminest

$ composer build

aufgerufen werden. Um zusätzlich den PHP-Quellcode zu testen:

$ composer test

Um nur den Coding-Style zu validieren:

$ composer style