Skip to content

Changes

Page history
Added directory "public", file "public/index.php" and links to the example... authored by Winder's avatar Winder 
Added directory "public", file "public/index.php" and links to the example files to section "Recommended Project Structure".
Show whitespace changes
Inline Side-by-side
Project-Structure.md
View page @ 728afdf7
......@@ -20,15 +20,18 @@
<details>
<summary>myModule.&lt;json|php&gt;</summary>
<p>This file contains all configurations, which are available only for the module "myModule".</p>
<p>Examples are provided in the project: [myModule.json](https://gitlab.com/windernet/php/framework/-/blob/main/src/configurations/module/myModule.json), [myModule.php](https://gitlab.com/windernet/php/framework/-/blob/main/src/configurations/module/myModule.php)</p>
</details>
</details>
<details>
<summary>global.&lt;json|php&gt;</summary>
<p>This file contains all global configurations, which are available to the whole project and all modules. Global means, that the configuration is independent of the environment (production, development, etc.); e.g. a switch, which can (de-)activate logging.</p>
<p>Examples are provided in the project: [global.json](https://gitlab.com/windernet/php/framework/-/blob/main/src/configurations/global.json), [global.php](https://gitlab.com/windernet/php/framework/-/blob/main/src/configurations/global.php)</p>
</details>
<details>
<summary>local.&lt;json|php&gt;</summary>
<p>This file contains all local configurations, which are available to the whole project and all modules. Local means, that the configuration is dependent of the environment (production, development, etc.); e.g. database credentials.</p>
<p>Examples are provided in the project: [local.json](https://gitlab.com/windernet/php/framework/-/blob/main/src/configurations/local.json), [local.php](https://gitlab.com/windernet/php/framework/-/blob/main/src/configurations/local.php)</p>
</details>
</details>
<details>
......@@ -39,9 +42,18 @@
<p>This directory contains all files (controllers, models, views, etc.), which make up the module "myModule".</p>
</details>
</details>
<details>
<summary>public</summary>
<p>This directory contains all public files of the project. Ideally, it contains only the index.php file.</p>
<details>
<summary>index.php</summary>
<p>The entry file of the project.</p>
<p>An example is provided in the project: [index.php](https://gitlab.com/windernet/php/framework/-/blob/main/src/public/index.php)</p>
</details>
</details>
<details>
<summary>test</summary>
<p>This directory contains all your tests. It should have the same structure like the module directory above; e.g. <code>test/module/myModule/</code>.</p>
<p>This directory contains all tests. It should have the same structure like the module directory above; e.g. <code>test/module/myModule/</code>.</p>
</details>
<details>
<summary>vendor</summary>
......