This page displays the README.md file of the GitHub repository.

MicroSymfony 🎶

About 🖋

MicroSymfony is a Symfony 7.1 application skeleton on steroids, ready to use.

I have made a long blog post explaining all it contains; it will be the reference for documentation. I'll update it when needed:

• Introducing the MicroSymfony application template

If you want to use the last Symfony 6.4 LTS version in your composer.json file, replace all occurrences of 7.1 with 6.4 and run composer up.

Table of Contents 📖

• About
• Demos
• Quick-start
  • With the Symfony binary
  • With FrankenPHP
• Requirements
  • Optional requirements
• Stack
• Features
• Feature branches
  • Infrastructure
  • Database
  • Tooling
• Notes
• Other good practices
• References
• Contributing
• Security
• Credits
• License

Demos 🌈

Because a live demo is always better than all explanations:

• Live demo at https://microsymfony.ovh
• Live demo powered by FrankenPHP at https://frankenphp.microsymfony.ovh

Quick-start ⚡

With the Symfony binary 🎶

You must have the Symfony binary and composer installed locally.

To create a new project from the GitHub template, run:

composer create-project strangebuzz/microsymfony && cd microsymfony

Then start the PHP server with make:

make start

Or with Castor:

castor start

Open https://127.0.0.1:8000 (considering your 8000 port is free) and enjoy! 🙂

With FrankenPHP 🧟‍

We can also use FrankenPHP to run MicroSymfony. You must have Docker installed locally.

Create a new project from the GitHub template, run:

docker run --rm -it -v $PWD:/app composer:latest create-project strangebuzz/microsymfony && cd microsymfony

Install the FrankenPHP Symfony runtime:

docker run --rm -it -v $PWD:/app composer:latest require runtime/frankenphp-symfony

Then run:

docker run \
    -e FRANKENPHP_CONFIG="worker ./public/index.php" \
    -e APP_RUNTIME=Runtime\\FrankenPhpSymfony\\Runtime \
    -v $PWD:/app \
    -p 80:80 -p 443:443 \
    -d \
    dunglas/frankenphp

Open https://localhost and enjoy! 🙂

PS: On Windows, replace $PWD with "%cd%".

You can also directly use the FrankenPHP branch.

Requirements ⚙

• PHP 8.2 (also works with PHP 8.3)
• The Symfony CLI

Optional requirements ⚙

• The Xdebug PHP extension if you want to run the code coverage report
• Castor task runner if you don't want to use Make and its Makefile

Stack 🔗

• Symfony 7.1
• Twig 3.8
• Hotwired stimulus 3.2 and Turbo 8.0
• PHPUnit 11.0
• The classless BareCSS CSS framework

PS: A fork of BareCSS was created to fix some issues as the project is not maintained anymore.

Features 🚀

MicroSymfony ships these features, ready to use:

• Two task runners
  • Make (source) (demo)
  • Castor (source) (demo)
• Static analysis with PHPStan
  • Configuration
• Coding standards with php-cs-fixer
  • Configuration
• Tests (demo)
  • Unit test example
  • Integration test example
  • Functional test example
  • API test example
  • E2E test example
• Code coverage at 100% (configurable threshold)
  • Coverage report on Scrutinizer
• GitHub CI (actions)
  • Tests job output
  • Lint job output
  • Security job output
• Asset mapper+Stimulus (documentation)
  • Vanilla Js (source) (demo)
  • Fetch on a JSON endpoint of the application (source) (demo)
• A custom error template
  • Source
  • Demo

Feature branches 🚅

Feature branches are not merged in the main branch but are used to integrate a new vendor library or make a POC. For example, have you ever dreamed of testing Eloquent, the Laravel ORM, on a Symfony project? Then clone the eloquent branch and run composer install && make load-fixtures.

Infrastructure

• FrankenPHP (PR, branch, rebased on 2024-09-26)
• Symfony-docker (PR, branch, rebased on 2024-10-20)

Database 💽

These « database » branches aim to display a list of records coming from a SQLite database.

• Doctrine DBAL (PR, branch, rebased on 2024-10-06)
• Eloquent ORM (PR, branch, rebased on 2024-10-13)

Tooling 🔨

• Taskfile (PR, branch, rebased on 2024-10-11)
• TwigStan (PR, branch, rebased on 2024-10-21)

These branches will be rebased after each release so they are always up to date.

Notes 📒

Turbo forms are disabled in assets/app.js. To enable the feature for a given form, add the data-turbo="true" attribute to it. Or change the parameter Turbo.setFormMode to on to activate the feature globally. In both cases, your controller code has to be modified accordingly.

Other good practices 👌

• Using strict types in all PHP files (source)
• Using the ADR pattern in an action controller (source) (doc)
• The composer.json file is normalized with ergebnis/composer-normalize
• Use of the composer bin plugin to install and run php-cs-fixer

References 📚

• A better ADR pattern for your Symfony controllers (strangebuzz.com)
• My Taskfile configuration for Symfony (jmsche.fr)
• You should be using PHPStans bleeding edge (backendtea.com)
• A Good Naming Convention for Routes, Controllers and Templates? (jolicode.com)
• Front-end application development, Symfony-style(s) (dunglas.dev)
• Automated Test Coverage Checks with Travis, PHPUnit for Github Pull Requests (ocramius.github.io)
• Installing and using php-cs-fixer (strangebuzz.com)
• Castor, a journey across the sea of task runners (jolicode.com)
• Initializing your Symfony project with solid foundations (strangebuzz.com)
• Organizing your Symfony project tests (strangebuzz.com)
• What are your Symfony best practices? (strangebuzz.com)
• Setting a CI/CD workflow for a Symfony project thanks to the GitHub actions (strangebuzz.com)
• The Symfony Framework Best Practices (symfony.com)

Contributing 🤝

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security 🧯

Please see SECURITY for details.

Credits 🙏

• COil
• All Contributors

License ⚖️

The MIT License (MIT). Please see License File for more information.