PHP Service Template

Contributing Quick start

Global dependencies:

• PHP 8.0
• Composer https://getcomposer.org/

# Install dependencies
composer install
# Run unit tests
composer test:unit
# Run linting/static-analysis
composer verify
composer verify:fix

OPT1 - Run app on host machine

docker-compose up -d devstack_app_deps;
composer test:integration:whitebox;

composer server:start;
composer message-processor:start;

composer test:integration:blackbox;

OPT2 - Run app Inside docker

docker-compose up -d devstack_app;
composer test:integration;

Goals

• Async PSR compliant HHTP server
• Async RabbitMQ Async message processor
• Async compatible postgres DB/ORM implementation

TODO

• Implement
  • HTTP server examples
  • RabbitMQ event processing examples
  • DB/ORM examples
• Deploy Infra and observability
  • Setup
    • Error reporting - sentry
    • Logging - Grafana cloud (Loki)
    • Metrics - Grafana cloud (prometheus)
    • Dashboard - Grafana cloud (grafana)
• Testing
  • Add unit test examples
  • Add integration tests that test app with dependencies
  • Use OpenAPI and/or AsyncAPI specs in integration tests
• Setup default vscode settings.json so works out of the box for debugging