From f13ab7f9e0df13a00f77c05d14e1d1cd86e1e43a Mon Sep 17 00:00:00 2001 From: Roman Date: Tue, 2 Apr 2024 13:13:07 +0200 Subject: [PATCH] README: project structure --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 50f3d57..2010561 100644 --- a/README.md +++ b/README.md @@ -316,6 +316,36 @@ php cli.php frontend rm php cli.php frontend dev ``` +## Project Structure +``` +├── Core +│ ├── API # Core API-Endpoints (User, Groups, Permissions, etc.) +│ ├── Configuration # Classes for configuration and settings +│ ├── Documents # Core Documents (Account, Admin, etc.) +│ ├── Driver # Logger and SQL drier implementation +│ ├── Elements # HTML element classes +│ ├── External # composer dependencies & external libraries +│ ├── Localization # Core translations +│ ├── Objects # Database objects & general classes +│ └── Templates # Core twig templates +├── Site # Site specific content and overwrites +│ ├── API +│ ├── Cache # Twig template and router cache +│ ├── Configuration # Dynamic configuration, e.g. database connection etc. +│ ├── Documents +│ ├── Localization +│ ├── Logs # Directory for log output, if the database fails +│ ├── Objects +│ └── Templates +├── react # react frontend +│ ├── shared # shared source files, including API and localization +│ ├── admin-panel # the admin panel source files +│ ├── dist # compiler output +├── [js/css/img/fonts/files/docs] # static web assets, files, licenses +├── docker # docker configuration files and build scripts +└── test # php unit & integraton test files +``` + ## Anything more? Feel free to contact me regarding this project and any other questions. \ No newline at end of file