Development Environment

Docker

The Transfer Object (TO) repository includes a development environment facilitated by a Docker SDK shell script.

To view all available commands and arguments (e.g., phpunit, phpstan, etc.), run the following command:

$ docker/sdk

Project Installation

To begin working with the Transfer Object (TO) project, please ensure you have Docker and Docker Compose installed on your system.

Follow these steps to set up the project:

1. Build Containers:

$ docker/sdk build

2. Run Container in Background:

$ docker/sdk start

3. Install Composer Dependencies:

$ docker/sdk composer install

4. Install CaptainHook: CaptainHook is a Git hook library for PHP projects.

$ docker/sdk hook-install

5. Verify CaptainHook Installation:

$ docker/sdk hook config:info

Xdebug Configuration

Xdebug is disabled by default. To enable Xdebug, follow these steps:

1. Stop Container:

$ docker/sdk stop

2. Rebuild with Xdebug Enabled:

$ docker/sdk -x build

3. Start the Container:

$ docker/sdk start