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

MicroSymfony 🎶

Introduction 🖋

MicroSymfony is a Symfony 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

So this blog post is the official documentation. This readme is a teaser of what MicroSymfony contains.

Demo 🌈

Because a live demo is always better than all explanations. Here is it:

• Live demo at https://microsymfony.ovh

Quick-start 🐰

Run

composer create-project strangebuzz/microsymfony
cd microsymfony

then

make start

or

castor symfony:start

Open https://127.0.0.1:8000 (if your 8000 port is free).

Enjoy!

Requirements ⚙

• PHP 8.1 (works with PHP 8.2)
• The Symfony CLI

Optional requirements ⚙

• The Xdebug PHP extension if you want to run the code coverage report
• Castor 0.8 task runner

Stack 🔗

• Symfony 6.3
• Twig 3
• Stimulus 3.2
• PHPUnit 9.5
• The classless BareCSS CSS framework

Features 🚀

MicroSymfony ships these features, ready to use:

• Two task runner
  • 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%
  • Output on CI
  • Failing output example
• GitHub CI (actions)
  • Tests job output
  • Lint 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

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

What it doesn't ship? ❌

• Doctrine (installation)

References 📚

• 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)