https://github.com/wayofdev/spiral-starter-tpl

🌪️ Pre-configured Spiral Framework Project Template with support of the Temporal. Includes PHPUnit, Pest PHP, PHPStan, PHP CS Fixer, and CI tools. Supports OpenAPI, DDD, Deptrac, Deployer, PHP 8.3, Docker, local SSL, and DNS. Your next choice for a SaaS project backend.
https://github.com/wayofdev/spiral-starter-tpl

boilerplate ddd php spiral spiral-api spiral-application spiral-boilerplate spiral-ddd spiral-framework spiral-starter-kit spiral-starter-template starter-kit starter-project starter-template temporal

Last synced: 10 months ago
JSON representation

🌪️ Pre-configured Spiral Framework Project Template with support of the Temporal. Includes PHPUnit, Pest PHP, PHPStan, PHP CS Fixer, and CI tools. Supports OpenAPI, DDD, Deptrac, Deployer, PHP 8.3, Docker, local SSL, and DNS. Your next choice for a SaaS project backend.

• Host: GitHub
• URL: https://github.com/wayofdev/spiral-starter-tpl
• Owner: wayofdev
• License: mit
• Created: 2023-04-21T11:27:33.000Z (almost 3 years ago)
• Default Branch: develop
• Last Pushed: 2025-03-31T21:43:40.000Z (11 months ago)
• Last Synced: 2025-04-12T00:16:25.056Z (10 months ago)
• Topics: boilerplate, ddd, php, spiral, spiral-api, spiral-application, spiral-boilerplate, spiral-ddd, spiral-framework, spiral-starter-kit, spiral-starter-template, starter-kit, starter-project, starter-template, temporal
• Language: PHP
• Homepage: https://wayof.dev
• Size: 1.36 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

          


    


    

        

            

            

        

    

    






    Build


    

    

    





    Project


    

    

    





    Quality


    

    

    





    Community


    

    






# Spiral Framework Starter Template

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

## 📄 About

To be added...




🙏 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:**

  * To be added...

* **Changed:**

  * To be added...

* **Removed:**

  * To be added...

### → Development Tools

* **Added:**

  * Style checker package for custom rule-sets to php-cs-fixer — [wayofdev/php-cs-fixer-config](https://github.com/wayofdev/php-cs-fixer-config)

  * [Phive](https://github.com/phar-io/phive) support for managing PHP tools

    * [ergebnis/composer-normalize](https://github.com/ergebnis/composer-normalize) composer plugin for normalizing composer.json file

    * [maglnet/ComposerRequireChecker](https://github.com/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](https://github.com/wayofdev/docker-php-dev) as PHP development environment with XDebug support out of the box

### → Testing

* **Added:**

  * Configured [PHPUnit](https://phpunit.de/index.html) for unit testing.

  * Integrated [Pest PHP](https://pestphp.com) for elegant console support and architecture testing.

  * [Infection](https://github.com/infection/infection) for mutation testing to ensure quality.

  * Mutation test reports are uploaded [Stryker Mutator Dashboard](https://dashboard.stryker-mutator.io).

### → Static Analysis

* **Added:**

  * Static analysis tool — [PHPStan](https://phpstan.org) and it's extensions:

    * [phpstan/extension-installer](https://github.com/phpstan/extension-installer) — automatic installation of PHPStan extensions

    * [phpstan/phpstan-deprecation-rules](https://github.com/phpstan/phpstan-deprecation-rules) — rules for detecting usage of deprecated classes, methods, properties, constants and traits.

    * [larastan/larastan](https://github.com/larastan/larastan) for Laravel-specific static analysis.

  * [Psalm](https://github.com/vimeo/psalm) static analysis tool and it's extensions:

    * [psalm/plugin-laravel](https://github.com/psalm/psalm-plugin-laravel) — Psalm plugin for Laravel

    * [psalm/plugin-phpunit](https://github.com/psalm/psalm-plugin-phpunit) — Psalm plugin for PHPUnit

  * [PHP Rector](https://github.com/rectorphp/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](https://pre-commit.com) package

### → Deployments

* **Added:**

  * [Deployer](https://deployer.org) for automatic deployments to staging and production servers with support of [GitHub Environments](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)

  * For more information see [Deployments](#-requirements) section

### → Services

* **Added:**

  * [Mailpit](https://github.com/axllent/mailpit) service to simplify email testing in development. Mailpit is an email testing tool that provides a web interface for viewing and managing test emails sent by the application.

  * [MinIO](https://min.io) service for object storage, compatible with the Amazon S3 API. This enables the application to store and retrieve files in a development environment.

  * [Temporal](https://temporal.io/) service is included by default for managing distributed workflows. The configuration for Temporal is located in the separate [docker-compose.temporal.yaml](./docker-compose.temporal.yaml) file, allowing easier integration with the main application.




## 🚩 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](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-22-04)

  * [How To Install Docker Desktop on Mac](https://docs.docker.com/desktop/install/mac-install/)

* **Cloned, configured and running** [docker-shared-services](https://github.com/wayofdev/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](https://github.com/wayofdev/docker-shared-services) repository to ensure system-wide TLS and DNS support.

### → Docker Shared Services

Check full instructions in [docker-shared-services](https://github.com/wayofdev/docker-shared-services) repository.

1. **Create shared project directory:**

   ```bash

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

   ```

2. **Clone `docker-shared-services` repository:**

    ```bash

    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:**

    ```bash

    make env

    ```

4. **Install root certificate** and generate default project certs:

    ```bash

    make cert-install

    ```

5. **Run shared services:**

    ```bash

    make up

    ```

### → Spiral 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 `spiral-starter-tpl` repository as starting point.

   ```bash

   git clone \

     git@github.com:wayofdev/spiral-starter-tpl.git \

     ~/projects/spiral-starter-tpl && \

   cd ~/projects/spiral-starter-tpl

   ```

2. **Generate** `.env` file

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

   ```bash

   $ make env \

       SHARED_SERVICES_NAMESPACE=ss \

       COMPOSE_PROJECT_NAME=spiral-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:

   ```bash

   $ make env \

       SHARED_SERVICES_NAMESPACE=ss \

       COMPOSE_PROJECT_NAME=spiral-starter-tpl \

       FORCE=true

   ```

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

   ```bash

   $ make

   # or run commands separately

   $ make hooks

   $ make install

   $ make key

   $ make prepare

   $ make up

   ```

4. **Open** your browser and navigate to `https://api.spiral-starter-tpl.docker` to see Laravel welcome page.




## 🧰 Project Architecture

The project architecture of `wayofdev/spiral-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](https://github.com/wayofdev/spiral-starter-tpl/blob/develop/app/deptrac.yaml) located in repository `app` folder.




## 🪄 Template

This project was generated from the [spiral/app](https://github.com/spiral/app) repository using the command: `composer create-project spiral/app spiral-starter-tpl` with the following selected options:

  View Setup Options

  ```bash

  Which application preset do you want to install?

  > [1] Web

  Create a default application structure and demo data?

  > [1] Yes

  Would you like to use SAPI?

  > [1] Yes

  Do you need Cycle ORM?

  > [1] Yes

  Which collections do you want to use with Cycle ORM?

  > [2] Laravel Collections

  Which validator component do you want to use?

  > [3] Laravel Validator

  Do you want to use Queue component?

  > [1] Yes

  Do you want to use Cache component?

  > [1] Yes

  Do you want to use Mailer component?

  > [1] Yes

  Do you want to use Storage component?

  > [1] Yes

  Which template engine do you want to use?

  > [3] Plain PHP

  Do you need Data Grid?

  > [1] Yes

  Do you want to use the Event Dispatcher?

  > [1] Yes

  Do you need a cron jobs scheduler?

  > [1] Yes

  Do you need Translator?

  > [0] No

  Do you need the Temporal?

  > [1] Yes

  Do you need the RoadRunner Metrics?

  > [1] Yes

  Do you need the Sentry?

  > [1] Yes

  ```