Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

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

Last synced: 2 months ago
JSON representation

Formatdatenbank

Awesome Lists containing this project

README

        

# GBV-Formatdatenbank

[![Build Status](https://img.shields.io/travis/gbv/format.gbv.de.svg?style=flat-square)](https://travis-ci.org/gbv/format.gbv.de)
[![Quality Score](https://img.shields.io/scrutinizer/g/gbv/format.gbv.de.svg?style=flat-square)](https://scrutinizer-ci.com/g/gbv/format.gbv.de)

Dieses Repository enthält den Quellcode und die Quelldaten der unter 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](https://getcomposer.org/) installiert:

$ composer install

Die Avram-Spezifikation und das dazu gehörige JSON Schema werden [in einem eigenen repository](https://github.com/gbv/avram) verwaltet, dass bei der Installation automatisch neu geklont wird.

## Quellcode

Zum Testen kann ein eigener Webserver erreichbar unter 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