apip-ddd

(β˜… 370)

An example of hexagonal API Platform 3 implementation

  • .dockerignore
  • .editorconfig
  • .env
  • .env.test
  • .gitattributes
  • .gitignore
  • .php-cs-fixer.dist.php
  • composer.json
  • composer.lock
  • deptrac_bc.yaml
  • deptrac_hexa.yaml
  • docker-compose.override.yml
  • docker-compose.prod.yml
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • Makefile
  • phpunit.xml.dist
  • psalm.xml
  • README.md
  • symfony.lock

# Installation Guide

1. Get the code
git clone https://github.com/mtarld/apip-ddd

Downloads the entire project code from GitHub to your computer.

cd apip-ddd

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.override.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
composer install

Installs the PHP libraries listed in composer.json.

βœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation