[Feature] [MST] Update to Symfony 6, improve project structure (#13)

Author: Timothylul

.env

@@ -16,6 +16,8 @@
 ###> symfony/framework-bundle ###
 APP_ENV=dev
 APP_SECRET=CHANGEME
+HOST=localhost
+SCHEME=http
 ###< symfony/framework-bundle ###
 
 ###> symfony/mailer ###
@@ -30,6 +32,3 @@ APP_SECRET=CHANGEME
 # DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7"
 DATABASE_URL="mysql://modular-symfony-template:modular-symfony-template@mysql:3306/modular-symfony-template?serverVersion=5.7"
 ###< doctrine/doctrine-bundle ###
-
-###> Team ###
-TEAM_LIMIT=10

.github/workflows/ci.yml

@@ -1,48 +1,46 @@
-# This is a basic workflow to help you get started with Actions
-
 name: CI
 
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events
   push:
     branches: [ '**' ]
   pull_request:
     branches: [ '**' ]
 
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
+  ci:
     runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+
       - uses: actions/checkout@v2
 
-      - name: Composer
-        uses: php-actions/composer@v5
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          tools: composer, phpstan, phpcs
+          extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite
 
-  quality:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
-      - uses: actions/checkout@v2
+      - name: Cache composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
 
-      - name: Composer
-        uses: php-actions/composer@v5
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+      - name: PHPCS
+        run: phpcs src/
 
       - name: PHPStan
-        uses: php-actions/phpstan@v3
-        with:
-          path: src/
-          level: 5
+        run: phpstan analyse --level 5 --no-progress src/
 
       - name: Codesniffer
         uses: pipeline-components/php-codesniffer@v0.12.3

.gitignore

@@ -31,4 +31,15 @@
 ###> deptrac-shim ###
 /tools/deptrac-shim/vendor/
 .deptrac.cache
-###< deptrac-shim ###
+###< deptrac-shim ###
+
+###> sitemap ###
+/public/sitemap.*
+###< sitemap ###
+
+###> symfony/webpack-encore-bundle ###
+/node_modules/
+/public/build/
+npm-debug.log
+yarn-error.log
+###< symfony/webpack-encore-bundle ###

README.md

@@ -15,10 +15,9 @@
     <img src="images/logo.png" alt="Logo" width="80" height="80">
   </a>-->
 
-<h3 align="center">Modular Symfony Application Template</h3>
+<h3 align="center">Modular Symfony Template</h3>
 
   <p align="center">
-    This template helps you to get started with the modular programming aproach within the Symfony framework
     <br />
     <a href="https://github.com/Tim-Koertgen/modular-symfony-template"><strong>Explore the docs »</strong></a>
     <br />
@@ -62,8 +61,6 @@
 <!-- ABOUT THE PROJECT -->
 ## About The Project
 
-After struggling to find a modular symfony template I decided to create my own. I decided to split the application into 5 main parts: Backend, Client, Core, Frontend and Shared. Each layer has its own tasks.
-
 ### Backend
 
 All your business logic should be located here. The backend layer is split into four layers
@@ -108,6 +105,7 @@ Shared contains classes that are used across the hole application like TransferO
 * [Twig](https://twig.symfony.com/)
 * [PHPDocker.io](https://phpdocker.io/)
 * [EasyAdminBundle](https://symfony.com/bundles/EasyAdminBundle/current/index.html)
+* [WebpackEncoreBundle](https://symfony.com/doc/current/frontend.html)
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -143,11 +141,9 @@ All you need to do is install [Docker](https://docs.docker.com/get-docker/) and
 ## Usage
 
 You should be able to access the following two endpoints after your installation is finished:
-- http://localhost:18000/team
+- http://localhost:18000/
 - http://localhost:18000/admin
 
-Adding a team in the backend UI will make it appear in the frontend. This is just a really simple example of how to build your modules to make them work together.
-
 <!--_For more examples, please refer to the [Documentation](https://example.com)_-->
 _Documentation is in progress_
 
@@ -158,7 +154,7 @@ _Documentation is in progress_
 <!-- ROADMAP -->
 ## Roadmap
 
-- [] Generate TransferObjects from XML schema files
+- Nothing specific planned. I keep the template up to date with the experience I gain from developing apps using this template
 
 See the [open issues](https://github.com/Tim-Koertgen/modular-symfony-template/issues) for a full list of proposed features (and known issues).
 
@@ -229,7 +225,7 @@ Project Link: [https://github.com/Tim-Koertgen/modular-symfony-template](https:/
 [license-url]: https://github.com/Tim-Koertgen/modular-symfony-template/blob/main/LICENSE.txt
 [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
 [linkedin-url]: https://linkedin.com/in/tim-körtgen
-[symfony-shield]: https://img.shields.io/badge/Symfony-5.3-red.svg?style=for-the-badge
-[symfony-url]: https://linkedin.com/in/tim-körtgen
+[symfony-shield]: https://img.shields.io/badge/Symfony-6.0-red.svg?style=for-the-badge
+[symfony-url]: https://symfony.com/
 [php-shield]: https://img.shields.io/badge/PHP-8.0-blue.svg?style=for-the-badge
-[php-url]: https://linkedin.com/in/tim-körtgen
+[php-url]: https://www.php.net/

assets/app.js

@@ -0,0 +1,12 @@
+/*
+ * Welcome to your app's main JavaScript file!
+ *
+ * We recommend including the built version of this JavaScript file
+ * (and its CSS file) in your base layout (base.html.twig).
+ */
+
+// any CSS you import will output into a single css file (app.css in this case)
+import './styles/app.css';
+
+// start the Stimulus application
+import './bootstrap';

assets/bootstrap.js

@@ -0,0 +1,11 @@
+import { startStimulusApp } from '@symfony/stimulus-bridge';
+
+// Registers Stimulus controllers from controllers.json and in the controllers/ directory
+export const app = startStimulusApp(require.context(
+    '@symfony/stimulus-bridge/lazy-controller-loader!./controllers',
+    true,
+    /\.[jt]sx?$/
+));
+
+// register any custom, 3rd party controllers here
+// app.register('some_controller_name', SomeImportedController);

assets/controllers.json

@@ -0,0 +1,11 @@
+{
+    "controllers": {
+        "@symfony/ux-chartjs": {
+            "chart": {
+                "enabled": true,
+                "fetch": "eager"
+            }
+        }
+    },
+    "entrypoints": []
+}

assets/controllers/hello_controller.js

@@ -0,0 +1,16 @@
+import { Controller } from '@hotwired/stimulus';
+
+/*
+ * This is an example Stimulus controller!
+ *
+ * Any element with a data-controller="hello" attribute will cause
+ * this controller to be executed. The name "hello" comes from the filename:
+ * hello_controller.js -> "hello"
+ *
+ * Delete this file or adapt it for your use!
+ */
+export default class extends Controller {
+    connect() {
+        this.element.textContent = 'Hello Stimulus! Edit me in assets/controllers/hello_controller.js';
+    }
+}

translations/.gitignore assets/styles/app.csstranslations/.gitignore renamed to assets/styles/app.css

@@ -4,14 +4,14 @@
 use App\Kernel;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 
-if (!is_file(dirname(__DIR__).'/vendor/autoload_runtime.php')) {
+if (!is_file(dirname(__DIR__) . '/vendor/autoload_runtime.php')) {
     throw new LogicException('Symfony Runtime is missing. Try running "composer require symfony/runtime".');
 }
 
-require_once dirname(__DIR__).'/vendor/autoload_runtime.php';
+require_once dirname(__DIR__) . '/vendor/autoload_runtime.php';
 
 return function (array $context) {
-    $kernel = new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
+    $kernel = new Kernel($context['APP_ENV'], (bool)$context['APP_DEBUG']);
 
     return new Application($kernel);
 };