strangebuzz / microsymfony
A template to initialize an application to use Symfony as a micro-framework
Installs: 38
Dependents: 0
Suggesters: 0
Security: 0
Stars: 39
Watchers: 1
Forks: 4
Open Issues: 6
Type:symfony-application-template
Requires
- php: >=8.2
- ext-ctype: *
- ext-dom: *
- ext-iconv: *
- ext-libxml: *
- ext-simplexml: *
- ext-xml: *
- league/commonmark: ^2.4
- symfony/asset: ~7.0.0
- symfony/asset-mapper: ~7.0.0
- symfony/console: ~7.0.0
- symfony/dotenv: ~7.0.0
- symfony/flex: ^2
- symfony/form: ~7.0.0
- symfony/framework-bundle: ~7.0.0
- symfony/http-foundation: 7.0.*
- symfony/http-kernel: 7.0.*
- symfony/intl: ~7.0.0
- symfony/monolog-bundle: ^3.8
- symfony/routing: 7.0.*
- symfony/runtime: ~7.0.0
- symfony/stimulus-bundle: ^2.0
- symfony/string: 7.0.*
- symfony/twig-bundle: ~7.0.0
- symfony/ux-turbo: ^2.16
- symfony/validator: ~7.0.0
- symfony/web-link: 7.0.*
- symfony/yaml: ~7.0.0
- twig/extra-bundle: ^3.0
- twig/markdown-extra: ^3.7
- twig/twig: ^3.0
Requires (Dev)
- bamarni/composer-bin-plugin: ^1.8
- phpstan/extension-installer: ^1.3
- phpstan/phpstan-symfony: ^1.3
- phpunit/phpunit: ^11.0
- roave/security-advisories: dev-latest
- symfony/browser-kit: ~7.0.0
- symfony/css-selector: ~7.0.0
- symfony/requirements-checker: ^2.0
- symfony/stopwatch: ~7.0.0
- symfony/web-profiler-bundle: ~7.0.0
Conflicts
README
Introduction 🖋
MicroSymfony is a Symfony 7.0 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:
So, this blog post is the official documentation. This readme is a teaser of what MicroSymfony contains.
If you want to use the last Symfony 6.4 LTS version in your composer.json
file, replace all occurrences of 7.0
with 6.4
, run composer up
, and you are
done.
Demo 🌈
Because a live demo is always better than all explanations. Here is it:
- 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 symfony:start
Open https://127.0.0.1:8000 (considering your 8000 port is free) and enjoy! 🙂
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! 🙂
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.0
- 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 runner
- Static analysis with PHPStan
- Coding standards with php-cs-fixer
- Tests (demo)
- Code coverage at 100%
- GitHub CI (actions)
- Asset mapper+Stimulus (documentation)
- A custom error template
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
What it doesn't ship? ❌
- Doctrine (installation)
References 📚
- 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)