Skip to content

README.md

Latest commit

 

History

History
85 lines (61 loc) · 2.47 KB

README.md

File metadata and controls

85 lines (61 loc) · 2.47 KB

Dart Back

A modern PHP application built with Symfony 7 following Clean Architecture and Domain-Driven Design principles for managing players, games, and scoring.

This project used to be a sandbox for learning and experimenting with new technologies and concepts in PHP development during my last employment. It's now a personal project that I work on for showing a part of what I can do.

Tech Stack

  • PHP 8
  • Symfony 7 framework
  • FrankenPHP (High-performance PHP application server)
  • Docker for containerization
  • PostgreSQL database
  • Clean Architecture and Domain-Driven Design methodology

Features

  • Player Management: Create, update, and manage players with unique names
  • Game Management: Track games, their statuses, and associated players
  • Scoring System: Record and retrieve scores for players in specific games
  • Event-Driven Architecture: Uses Symfony Messenger for handling domain events
  • Validation: Ensures data integrity with Symfony Validator
  • Error Handling: Graceful handling of validation and transactional errors

Prerequisites

  • Docker Compose (v2.10+)
  • Git

Installation

  1. Clone the repository:

    git clone https://github.com/PALandoin/Dart_Back
cd Dart_Back

  2. Build the project:

    docker compose build --no-cache

  3. Start the application:

    docker compose up --pull always -d --wait

  4. Access the application:

  5. Stop the application:

    docker compose down --remove-orphans

Configuration

  • Environment Variables: Configure database credentials and other settings in the .env file
  • Database: PostgreSQL is used as the default database. Ensure the POSTGRES_* variables are set correctly

Development

  • Testing: Use PHPUnit for unit and integration tests
  • Validation: Symfony Validator ensures data consistency
  • Event Listeners: Custom event listeners handle domain events like PlayerCreatedEvent

Deployment

  • Production Ready: Optimized for production with Docker and Symfony best practices
  • HTTPS: Automatic HTTPS setup with Caddy

Troubleshooting

  • Database Issues: Check Docker logs for the database service: 
    docker compose logs database
  • Validation Errors: Ensure data meets the validation rules defined in the domain models

License

This project is available under the MIT License.