strangebuzz/microsymfony

A template to initialize an application to use Symfony as a micro-framework

6.3.4 2023-08-31 20:04 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• ext-simplexml: *
• ext-xml: *
• league/commonmark: ^2.3
• symfony/asset: 6.3.*
• symfony/asset-mapper: 6.3.*
• symfony/console: 6.3.*
• symfony/dotenv: 6.3.*
• symfony/flex: ^2
• symfony/form: 6.3.*
• symfony/framework-bundle: 6.3.*
• symfony/intl: 6.3.*
• symfony/monolog-bundle: ^3.8
• symfony/runtime: 6.3.*
• symfony/stimulus-bundle: ^2.9
• symfony/twig-bundle: 6.3.*
• symfony/validator: 6.3.*
• symfony/web-link: 6.3.*
• symfony/yaml: 6.3.*
• twig/extra-bundle: ^2.12 || ^3.0
• twig/markdown-extra: ^3.5
• twig/twig: ^2.12 || ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• phpstan/extension-installer: ^1.2
• phpstan/phpstan-symfony: ^1.2
• phpunit/phpunit: ^9.0
• symfony/browser-kit: 6.3.*
• symfony/css-selector: 6.3.*
• symfony/phpunit-bridge: ^6.3

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *
• symfony/polyfill-php73: *
• symfony/polyfill-php74: *
• symfony/polyfill-php80: *
• symfony/polyfill-php81: *

MIT

• symfony
• php
• rad
• poc
• micro-framework
• project-template
• web-application

README

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

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

• https://www.strangebuzz.com/en/blog/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

Requirements ⚙

• PHP 8.1 (works with PHP 8.2)
• The Symfony CLI
• The Xdebug PHP extension if you want to run the code coverage report (optional)
• Castor 0.8 task runner (optional)

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)

What it doesn't ship? ❌

• The debug toolbar (installation)
• Doctrine (installation)

References 📚

• https://jolicode.com/blog/castor-a-journey-across-the-sea-of-task-runners