phil/microsymfony

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

7.0.1 2024-03-01 00:54 UTC

Requires

• php: >=8.3
• ext-ctype: *
• ext-dom: *
• ext-iconv: *
• ext-libxml: *
• ext-simplexml: *
• ext-xml: *
• league/commonmark: ^2.4
• symfony/asset: 7.0.*
• symfony/asset-mapper: 7.0.*
• symfony/console: 7.0.*
• symfony/dotenv: 7.0.*
• symfony/flex: ^2.4
• symfony/form: 7.0.*
• symfony/framework-bundle: 7.0.*
• symfony/intl: 7.0.*
• symfony/monolog-bundle: ^3.10
• symfony/runtime: 7.0.*
• symfony/stimulus-bundle: ^2.16
• symfony/translation: 7.0.*
• symfony/twig-bundle: 7.0.*
• symfony/validator: 7.0.*
• symfony/web-link: 7.0.*
• symfony/yaml: 7.0.*
• twig/extra-bundle: ^3.8
• twig/markdown-extra: ^3.8
• twig/twig: ^3.8

Requires (Dev)

• bamarni/composer-bin-plugin: ^1.8
• phpstan/extension-installer: ^1.3
• phpstan/phpdoc-parser: ^1.26
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-strict-rules: ^1.5
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^11.0
• rector/rector: ^1.0
• roave/security-advisories: dev-latest
• symfony/browser-kit: 7.0.*
• symfony/css-selector: 7.0.*
• symfony/debug-bundle: 7.0.*
• symfony/maker-bundle: ^1.55
• symfony/panther: ^2.1
• symfony/requirements-checker: ^2.0
• symfony/stopwatch: 7.0.*
• symfony/var-dumper: 7.0.*
• symfony/web-profiler-bundle: 7.0.*

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: *
• symfony/polyfill-php82: *
• symfony/polyfill-php83: *

MIT

• Philippe Gamache

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

README

“Proclaim Honestly, Interact Liberally” MicroSymfony is a Symfony 7.0 application skeleton on steroids, ready to use.

The purpose of MicroSymfony is to provide a sandbox with some sensible defaults and ready to use. It can be a solution if you want to quickly set up something, create a POC, test things, and even make a small "one-page" application.

It was base on strangebuzz/MicroSymfony with adjustment we're usually adding on all our projects. We also remove many examples.

Demo 🌈

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

• Live demo will be available at https://ph-il.ca/demos/microsymfony

Requirements ⛮

All “Proclaim Honestly, Interact Liberally” project will use the latest version within 1 or 2 months depending on dependencies availability.

• PHP 8.3
• The Symfony CLI

Optional requirements ⚙

• The Xdebug PHP extension if you want to run the code coverage report (optional but recommended)
• Castor 0.13 task runner

Stack 🔗

All “Proclaim Honestly, Interact Liberally” project will use the latest version within 1 or 2 months depending on dependencies availability.

• Symfony 7.0
• Twig 3.8
• Stimulus 3.2
• PHPUnit 11.0

Features 🚀

MicroSymfony ships these features, ready to use:

• One task runner
  • Castor (source)
• Static analysis with PHPStan
  • Configuration
• Coding standards with php-cs-fixer
  • Configuration
• Refactoring with Rector
  • Configuration
• The debug toolbar (doc)
• Tests (organisation)
  • 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)
• Symfony Maker (documentation)
• 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
• Use of the composer bin plugin to install and run php-cs-fixer.

What it doesn't ship? ❌

• Doctrine (installation) or use (WebSymfony)
• Any CSS (Installation to come) or use (WebSkeleton)

Initializing an application with MicroSymfony 🪄

Initializing using composer

As the application template is registered on Packagist, you can use composer to install it with the following command:

$ composer create-project phil/microsymfony

It creates a microsymfony directory with the new project. In this case, you must set up Git and a repository yourself. But that's the fastest way to test it.

Note that the composer install command downloads all the required dependencies and builds the assets.

Initializing from Github site

Or use the GitHub template:

Initializing from Github CLI

$ gh repo create my-project --clone --private --template parler-haut-interagir-librement/WebSymfony

Serving the application

To serve the application with the Symfony binary, run:

$ symfony server:start --daemon

or use the castor command

$ castor symfony:start

The application is now available at https://127.0.0.1:8000 (considering your 8000 port is available).

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)

Others “Proclaim Honestly, Interact Liberally” Skeletons 🩻

• WebSymfony

  • MicroSymfony+
  • Database
    • StofDoctrineExtensionsBundle
  • EasyAdmin
  • Security Layers
    • SymfonySecurity
    • NelmioSecurityBundle
    • NelmioCorsBundle
  • more.

• ApiSymfony

  • API Platform
  • Task runner
    • Castor
  • Static Analysis
    • PHPStan
  • Coding standards
    • php-cs-fixer
  • Refactoring
    • Rector
  • Tests
    • Unit test
    • API test
    • E2E test
  • GitHub CI
  • Symfony Maker

• WebSkeleton

  • WebSymfony +
  • CSS framework
    • Tailwind CSS
    • DaisyUI : Add semantic to Tailwind CSS
  • “Proclaim Honestly, Interact Liberally” Bundles
    • phil-ux - Add Base Twig Components
      • Install Tailwind CSS and DaisyUI
      • Add Base Twig Components using DaisyUI semantic
    • PhilDoctrineExtensionStofBundle - Add missing stuff to StofDoctrineExtensionsBundle
    • PhilDoctrineExtensionPublishBundle - Add Publish functionality to Doctrine Entity
  • more.