Enterprise Skeleton Project

A comprehensive project skeleton for enterprise applications with integrated support for essential development services and best practices.

Features

• 🚀 Modern PHP 8.3
• 🛠 Multiple web servers (Nginx, Apache)
• 📊 SQL & NoSQL databases
• 💾 Caching solutions
• 📨 Message brokers
• 🔍 Search engines
• 📊 Monitoring tools
• 📧 Mail testing
• 📝 Logging systems
• 📚 API documentation
• ⏰ Task scheduling

Frameworks

To switch between frameworks, use the following command:

# Example: Switch to Laravel framework
make framework laravel

# Example: Switch to Symfony framework
make framework symfony

---

Quick Start

1. Copy configuration:

make copy-config

2. Configure environment:

   • Edit infrastructure/config/cs-config to customize services
   • Just uncomment what you need. Example:

   • server=nginx            # Web Server: nginx, apache
     database=postgres       # Database Service: postgres, mysql
     ;nosql=mongodb          # NoSQL Database Service: mongodb, cassandra
     cache=redis             # Cache Service: redis, memcached
     ;search=elasticsearch   # Search: elasticsearch, solr
     ;message=kafka          # Message Broker: rabbitmq, kafka
     docs=swagger            # API Documentation: swagger
     ;mailer=mailhog         # Mail Sandbox: mailhog, papercut
     ;monitoring=grafana     # Monitoring: grafana, zabbix
     ;logs=kibana            # Log Management: kibana, graylog
     ;job=cron               # Scheduling Jobs: cron
     

3. Install and start:

make install

---

Infrastructure Components

PHP container will be build automatically depend on which services you choose.

Category	Service	Version	Access URL
Web Servers	Nginx Apache	stable-alpine 2.4	http://localhost:1000 https://localhost:1001
Databases	PostgreSQL MySQL MongoDB Cassandra	15 8.0 6.0 4.1	-
Caching	Redis Memcached	7.2-alpine 1.6-alpine	-
Message Brokers	RabbitMQ Kafka	3.12-alpine 3.3.1	http://localhost:15672 http://localhost:8080
Search	Elasticsearch Solr	8.11.1 9.3	-
Monitoring	Zabbix Grafana	6.4 10.2.0	http://localhost:8081 http://localhost:3000
Mail Testing	Mailhog Papercut	v1.0.1 5.7.0	http://localhost:8025 http://localhost:37408
Logging	Kibana Graylog	8.11.1 5.2	http://localhost:5601 http://localhost:9400
Documentation	Swagger	v5.9.1	http://localhost:1002
Task Scheduling	Cron	PHP 8.3-cli	-

---

Project Architecture

Domain-Driven Structure

• Modular architecture in src/ directory

• Independent ADR approach

• Independent domain modules

• Each module contains:

  • Domain logic
  • Infrastructure layer
  • Module-specific config
  • Test suite

• Recommended structure:

src/
└── YourDomain/
    ├── Application/
    │   └── YourUseCase/
    |       └── Query/
    │       └── Command/ 
    ├── DomainModel/
    │   ├── Model/
    │   ├── Repository/
    │   └── Service/
    ├── Infrastructure/
    │   ├── Persistence/
    │   │     └── InMemmory/
    │   │        └── Repository/
    │   └── Clients/
    ├── Presentation/
    │   └── Api/
    |       └── Request/
    │       └── Response/ 
    │   ├── Console/
    │   └── Web/
    |       └── Request/
    │       └── Response/ 
    ├── Resources/
    |       └── Config/
    |       └── Assets/
    │       └── Template/ 
    └── Tests/
        ├── Unit/
        └── Integration/

Adding New Domains

1. Create domain in /src/YourDomain
2. Register your provider in code/config/app.php (Laravel) or code/config/packages/domains.yaml (Symfony)
3. Follow existing domain structure.

---

Development Tools

Tool	Purpose	Command
PHP CS Fixer	Code standards	make phpcs
Deptrac	Architecture validation	make deptrac
PHPStan	Static analysis	make phpstan
Psalm	Type checking	make psalm
PhpMetrics	Php metrics	make phpmetrics
PHPUnit	Testing	make test-php
Newman	API testing	make test-postman

Config

Purpose	Command
Copy cs-config.ini.dist to cs-config file	make copy-config
Display current configuration	make show-config

Code Quality & Testing

Purpose	Command
Clear caches and dump autoload	make cc
Run all code quality checks	make ci

Logs

Purpose	Command
View cron output logs	make logs-cron
View PHP logs	make logs-php

... And others.

Additional Features

Health check

The project includes a set of health check commands to monitor various services.

All commands return:

• Success (0): When the service is available and functioning correctly
• Failure (1): When there are connection issues or service malfunctions

Usage example:

# Test MySQL connection
php bin/console app:healthcheck:mysql

Request Tracking

• Automatic Request-ID generation
• UUID v4 format
• Header-based tracking

SSL/HTTPS

• Development certificates included
• HTTP to HTTPS redirect
• TLS 1.2/1.3 support
• Custom certificate support (place in etc/containers/nginx/ssl/)

Cron Jobs

• Docker-based scheduling
• Configure in infrastructure/crontab
• Monitor with docker-compose exec cron crontab -l

API Testing

• Postman collection in tools/postman
• Environment variables support
• Automated testing via Newman

---

Configurations

Graylog Setup

1. Install GELF PHP package:

composer req graylog2/gelf-php

2. Configure UDP Input:

• Access http://localhost:9400
• Navigate to System → Inputs
• Add "GELF UDP" input on port 12201

Elasticsearch, Kibana & Logstash (ELK) Configuration

1. Create index

  curl -X PUT http://localhost:9200/logs -H Content-Type: application/json -d {"settings":{"number_of_shards":1,"number_of_replicas":0},"mappings":{"properties":{"@timestamp":{"type":"date"},"message":{"type":"text"},"level":{"type":"keyword"},"channel":{"type":"keyword"},"context":{"type":"object"}}}}

2. Reload logstash

  docker compose -f infrastructure/docker-compose-tools.yml --profile elk restart logstash

---

Contributing

We welcome contributions to the Enterprise Skeleton project! If you'd like to join the development effort, you can contribute by creating Pull Requests (PRs).

Current Development Priorities

We are currently looking for contributions in the following areas:

• Sentry Integration: We need help implementing Sentry for error tracking and monitoring. If you have experience with Sentry integration in PHP applications, we'd love your contribution!
• RoadRunner Integration: We are looking to integrate RoadRunner as a high-performance PHP application server. If you have experience with RoadRunner implementation, your contribution would be valuable!
• New Framework Integrations: We are actively looking to expand our framework support. If you'd like to integrate a new PHP framework (like Yii, Slim, or others), we welcome your contribution! Each framework should:

How to Submit a Pull Request

1. Fork the repository
2. Create a new branch for your feature or fix
3. Make your changes following our coding standards
4. Write or update tests if necessary
5. Submit a Pull Request with a clear description of the changes
6. Ensure all checks pass (PHPStan, Psalm, CS-Fixer, etc.)

License

This project is licensed under the MIT License.

Author

Dykyi Roman