| ... | ... | @@ -6,4 +6,45 @@ |
|
|
|
<hr />
|
|
|
|
<details>
|
|
|
|
<summary><Project Directory></summary>
|
|
|
|
<p>This directory contains the whole project. Anything, which is part of the project, should not be outside of this directory.</p>
|
|
|
|
<details>
|
|
|
|
<summary>bin</summary>
|
|
|
|
<p>This directory contains all executable scripts; e.g. a script, which runs all tests.</p>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
|
|
<summary>configurations</summary>
|
|
|
|
<p>This directory contains all configurations for the whole project. The configuration files should all be of the same kind; e.g. they should all be JSON files.</p>
|
|
|
|
<details>
|
|
|
|
<summary>module</summary>
|
|
|
|
<p>This directory contains all module configurations (configurations, which are available only for a specific module). Each module should have its own configuration file.</p>
|
|
|
|
<details>
|
|
|
|
<summary>myModule.<json|php></summary>
|
|
|
|
<p>This file contains all configurations, which are available only for the module "myModule".</p>
|
|
|
|
</details>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
|
|
<summary>global.<json|php></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>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
|
|
<summary>local.<json|php></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>
|
|
|
|
</details>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
|
|
<summary>module</summary>
|
|
|
|
<p>This directory contains all modules of the project.</p>
|
|
|
|
<details>
|
|
|
|
<summary>myModule</summary>
|
|
|
|
<p>This directory contains all files (controllers, models, views, etc.), which make up the module "myModule".</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>
|
|
|
|
</details>
|
|
|
|
<details>
|
|
|
|
<summary>vendor</summary>
|
|
|
|
<p>This directory contains all third party packages, which are used in the project; e.g. the [WinderNet PHP Framework](https://gitlab.com/windernet/php/framework).</p>
|
|
|
|
</details>
|
|
|
|
</details> |
|
|
\ No newline at end of file |
