Build

Project

Quality

Community

Laravel Starter Template

This is an opinionated modified version of the Laravel framework which aims at providing a Domain-Driven Design (DDD) structure.

📄 About

Laravel is a popular PHP web framework that provides an easy and efficient way to build web applications. However, the default structure of Laravel, coupled with Eloquent's active record pattern, may not always fit the needs of a project that requires a Domain-Driven Design (DDD) architecture. Eloquent's active record pattern breaks DDD principles and make it difficult to separate your business logic from your infrastructure code.

This repository provides a modified file structure for Laravel that follows DDD principles and tries to adhere to best practices, such as those outlined in Spatie's Laravel Beyond CRUD. The goal is to provide a starting point for building Laravel applications using a DDD approach, while still leveraging the power and convenience of the Laravel framework.

🙏 If you find this repository useful, consider giving it a ⭐️. Thank you!

🚀 Features

This starter template includes several added, changed, and removed features:

→ Framework Modifications

• Added:

  • Strict types declaration in all PHP files
  • Application dockerization using docker-compose and Makefile — use make help to view available commands
  • spatie/laravel-route-attributes package for route definition using PHP8 style attributes

• Changed:

  • Marked default Laravel classes as final
  • Modified file structure to meet DDD principles (as close as possible)
  • Changed config folder files to use default PHP multi-line comment style

• Removed:

  • Dependencies like Laravel Sanctum, Laravel Pint, and Laravel Sail
  • Broadcasting service provider and its routes. It can be added back if required for the project
  • Console routes in favor of Command classes
  • Sanctum migration files

→ Development Tools

• Added:
  • Style checker package for custom rule-sets to php-cs-fixer — wayofdev/php-cs-fixer-config
  • Phive support for managing PHP tools
    • ergebnis/composer-normalize composer plugin for normalizing composer.json file
    • maglnet/ComposerRequireChecker to check whether a specific composer package uses imported symbols that aren't part of its direct composer dependencies
  • Application dockerization using docker-compose and Makefile — use make help to view available commands
    • docker-php-dev as PHP development environment with XDebug support out of the box

→ Testing

• Added:
  • Configured PHPUnit for unit testing.
  • Integrated Pest PHP for elegant console support and architecture testing.
  • Infection for mutation testing to ensure quality.
  • Mutation test reports are uploaded Stryker Mutator Dashboard.

→ Static Analysis

• Added:
  • Static analysis tool — PHPStan and it's extensions:
    • phpstan/extension-installer — automatic installation of PHPStan extensions
    • phpstan/phpstan-deprecation-rules — rules for detecting usage of deprecated classes, methods, properties, constants and traits.
    • larastan/larastan for Laravel-specific static analysis.
  • Psalm static analysis tool and it's extensions:
    • psalm/plugin-laravel — Psalm plugin for Laravel
    • psalm/plugin-phpunit — Psalm plugin for PHPUnit
  • PHP Rector for automated code upgrades and refactoring, maintaining modern code standards.

→ Continuous Integration

• Added:
  • GitHub action workflows for:
    • Continuous integration which includes coding standards checks, unit testing and static analysis
    • Automatic pull-request labeling
  • Git pre-commit hooks using pre-commit package

→ Deployments

• Added:
  • Deployer for automatic deployments to staging and production servers with support of GitHub Environments
  • For more information see Deployments section

🚩 Requirements

To use this repository, you need to meet the following requirements:

• Operating System: macOS Monterey+, Linux, or Windows with WSL2.
• Docker: Version 26.0.0 or newer. Installation guides:
  • How To Install and Use Docker on Ubuntu 22.04
  • How To Install Docker Desktop on Mac
• Cloned, configured and running docker-shared-services to support system-wide DNS, routing, and TLS support via Traefik.

💿 Installation

Note

You should configure, set up, and run the docker-shared-services repository to ensure system-wide TLS and DNS support.

→ Docker Shared Services

Check full instructions in docker-shared-services repository.

1. Create shared project directory:

   mkdir -p ~/projects/infra && cd ~/projects/infra

2. Clone docker-shared-services repository:

   git clone \
   git@github.com:wayofdev/docker-shared-services.git \
   ~/projects/infra/docker-shared-services && \
   cd ~/projects/infra/docker-shared-services

3. Create .env file:

   make env

4. Install root certificate and generate default project certs:

   make cert-install

5. Run shared services:

   make up

→ Laravel Starter Template

1. Clone repository:

   After forking or creating generating repository from template, you can clone it to your local machine. In this example we will use laravel-starter-tpl repository as starting point.

   git clone \
     git@github.com:wayofdev/laravel-starter-tpl.git \
     ~/projects/laravel-starter-tpl && \
   cd ~/projects/laravel-starter-tpl

2. Generate .env file

   Generate .env file from .env.example file using Makefile command:

   $ make env \
       APP_NAME=laravel \
       SHARED_SERVICES_NAMESPACE=ss \
       COMPOSE_PROJECT_NAME=laravel-starter-tpl

   Change generated .env file to match your needs, if needed.

   (Optional): to re-generate .env file, add FORCE=true to the end of command:

   $ make env \
       APP_NAME=laravel \
       SHARED_SERVICES_NAMESPACE=ss \
       COMPOSE_PROJECT_NAME=laravel-starter-tpl \
       FORCE=true

3. Build, install and run. This will also generate Laravel app key:

   $ make
   
   # or run commands separately
   $ make hooks
   $ make install
   $ make key
   $ make prepare
   $ make up

4. Open your browser and navigate to https://laravel-starter-tpl.docker to see Laravel welcome page.

🧰 Project Architecture

The project architecture of wayofdev/laravel-starter-tpl follows a structured approach with distinct layers:

• Domain: Contains core business logic and entities.
• Bridge: Connects the domain layer with external systems or services.
• Infrastructure: Handles interactions with external systems, such as databases, APIs, or file systems.
• Support: Provides general-purpose helper classes that assist various parts of the application.
• DatabaseSeeders: Handles database seeding logic.
• DatabaseFactories: Manages database factory definitions.
• Tests: Contains test cases for various layers of the application.

Each layer has defined dependencies, ensuring a clear separation of concerns and facilitating maintainability and scalability.

For more information check deptrac.yaml located in repository app folder.

→ Architecture Diagram

🤖 Deployment to Staging and Production

This repository utilizes GitHub Actions for continuous deployment to both staging and production servers. Below is a description.

→ Deployment Flow

Deployment to Staging

1. Push to develop branch: Initiates the deployment process to the staging server. Merge PR against develop branch, to trigger deploy-staging.yml
2. GitHub Actions: Executes the deploy-staging.yml workflow.
3. Staging Server: Receives deployment instructions and acknowledges the deployment.

Deployment to Production

1. Merge of develop branch into master: Triggers the deployment process to the production server on push event.
2. GitHub Actions: Runs the create-release.yml workflow.
3. Release Event: deploy-release.yml waits for the event release: released.
4. GitHub Actions: Initiates the deploy-release.yml workflow.
5. Production Server: Receives deployment instructions and acknowledges the deployment.

Conditional Deployment Status

• Deployment Successful: Both staging and production servers send a success message back to GitHub Actions. Additionally, a success message is sent to the Slack server.

• Deployment Failed: If an error occurs, a failure message is sent back to GitHub Actions. Additionally, a failure message is sent to the Slack server.

Diagram

🧱 Credits and Useful Resources

Useful resources about Laravel and DDD approach:

• Laravel Beyond CRUD

🔒 Security Policy

This project has a security policy.

🙌 Want to Contribute?

Thank you for considering contributing to the wayofdev community! We are open to all kinds of contributions. If you want to:

• 🤔 Suggest a feature
• 🐛 Report an issue
• 📖 Improve documentation
• 👨‍💻 Contribute to the code

You are more than welcome. Before contributing, kindly check our contribution guidelines.

🫡 Contributors

🌐 Social Links

• Twitter: Follow our organization @wayofdev and the author @wlotyp.
• Discord: Join our community on Discord.

⚖️ License