Skip to content

kitodo/kitodo-publication

Repository files navigation

kitodo-publication

Scrutinizer Code Quality

Kitodo.Publication is free software, an extension for TYPO3 and part of the Kitodo Digital Library Suite. It implements the user and administrator interfaces for a document and publication server.

DDEV Development Environment

This extension provides a TYPO3 environment powered by DDEV. For more information check out the DDEV documentation.

Start and Configuration

  1. ddev start to start all containers
  2. ddev first-install to install TYPO3 and all extensions
  3. ddev import-db -f db.sql.gz to import a prepared database
  4. ddev launch typo3 to go to the backoffice login page

Steps 1–3 are mandatory after the initial checkout to set up the virtual environment.

TYPO3 backend credentails

  • Username: admin
  • Password: adminadmin

Running Unit Tests

Run all the extensions unit tests simply by executing ddev test.

Debugging

You need to enable XDebug in the web container with ddev xdebug on. The web container XDebug will try to connect with the PHP debugger on you host on port 9003.

For debug to work you must define the proper path mappings from the web container to your host project directory. There is a ready For Visual Studio Code users under .vscode/launch.json.

Running XDebug comes with some performance impact. To disable XDebug type ddev xdebug off.

More information

Funding

Funded by European Regional Development Fund (EFRE)

EFRE LOGO