Folders structure

This section contains information regarding the main structure of folders in this project

📦 root
┣ 📂 config
┣ 📂 docker
┣ 📂 github
┣ 📂 public
┃ ┗ 📂 assets
┃ ┗ 📂 upload
┣ 📂 src
┃ ┗ 📂 Action
┃ ┗ 📂 Command
┃ ┗ 📂 Controller
┃ ┗ 📂 DTO
┃ ┗ 📂 DataFixtures
┃ ┗ 📂 Entity
┃ ┗ 📂 Form
┃ ┗ 📂 Listeners
┃ ┗ 📂 Migrations
┃ ┗ 📂 Repository
┃ ┗ 📂 Services
┃ ┗ 📂 Twig
┃ ┗ 📂 VO
┃ ┗ 📂 assets
┣ 📂 templates
┣ 📂 tests
┣ 📂 translations
┣ 📂 vendor_fixes

---

./config

note

Contains the configuration of Symfony, Doctrine, Services, Security, Caching, Project itself, modes/environments

./docker

note

Docker configuration

./github

note

These are just files used directly in the github project (for readme)

./templates

note

Twig view files

./tests

note

Base structure prepared for phpUnit (contain only few simple tests)

./translations

note

Strings translations files used in symfony, contains almost all texts visible in gui, can be translated to other languages as well,

./vendor_fixes

note

This is a special folder containing fixes to given vendor packages due to unmaintained, bugged packages etc.

./public/assets

note

Contains the compiled files used by the project

./public/upload

note

Uploaded files

./src/Action

note

Contain definitions of all existing callable routes

./src/Command

note

Contain logic callable via CLI

./src/Controller

note

Controls the flow of the logic in the project

./src/DTO

note

Special objects/classes used to move data between logic layers

./src/DataFixtures

note

Demo data generators

./src/Entity

note

Object representation of single entry in given table in database

./src/Form

note

Contain logic regarding the form, handling of submissions or form input types

./src/Listeners

note

logic responding to the event triggers

./src/Migrations

note

Special classes containing executable sqls which change/update the database state

./src/Repository

note

Classes containing logic bound strictly to the database (sqls, queryBuilders etc.)

./src/Services

note

Definitions of special reusable logic around the project

./src/Twig

note

Definitions of logic (methods) usable in templates (twig)

./src/VO

note

Similar to DTO but contains inner logic bound to the transferred element

./src/assets

note

Raw css/js/translations which are then compiled as bundle