Skip to content

Commit

Permalink
linting
Browse files Browse the repository at this point in the history
Signed-off-by: alexmerlin <[email protected]>
  • Loading branch information
alexmerlin committed Oct 3, 2024
1 parent d9d3d35 commit efae230
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/book/v1/installation/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Recommended development environment

> If you are using Windows as OS on your machine, you can use WSL2 as development environment.
>
>
> Read more on [dotkernel.com](https://www.dotkernel.com/php-development/almalinux-9-in-wsl2-install-php-apache-mariadb-composer-phpmyadmin/).
Using your terminal, navigate inside the directory you want to download the project files into.
Expand Down
50 changes: 25 additions & 25 deletions docs/book/v1/introduction/file-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,30 @@ This directory contains one file, `clear-config-cache.php` which removes the con

This directory contains all application-related config files:

- `config.php`: here you will register ConfigProviders after installing packages
- `container.php`: main service container, providing access to all registered services
- `development.config.php.dist`: gets symlinked as `development.config.php` when enabling development mode - activates debug mode
- `pipeline.php`: contains a list of middlewares, in their order of execution
- `twig-cs-fixer.php`: configuration file for Twig code style checker/fixer
* `config.php`: here you will register ConfigProviders after installing packages
* `container.php`: main service container, providing access to all registered services
* `development.config.php.dist`: gets symlinked as `development.config.php` when enabling development mode - activates debug mode
* `pipeline.php`: contains a list of middlewares, in their order of execution
* `twig-cs-fixer.php`: configuration file for Twig code style checker/fixer

#### `autoload` directory

This directory contains all service-related local and global config files:

- `app.global.php`: sets the application name
- `dependencies.global.php`: config file to set global dependencies that should be accessible by all modules
- `development.local.php.dist`: gets symlinked as `development.local.php` when enabling development mode - activates error handlers
- `error-handling.global.php`: configures and activates error logs
- `local.php.dist`: local config file where you can overwrite application name and URL
- `mezzio.global.php`: Mezzio core config file
- `templates.global.php`: dotkernel/dot-twigrenderer config file
* `app.global.php`: sets the application name
* `dependencies.global.php`: config file to set global dependencies that should be accessible by all modules
* `development.local.php.dist`: gets symlinked as `development.local.php` when enabling development mode - activates error handlers
* `error-handling.global.php`: configures and activates error logs
* `local.php.dist`: local config file where you can overwrite application name and URL
* `mezzio.global.php`: Mezzio core config file
* `templates.global.php`: dotkernel/dot-twigrenderer config file

### `data` directory

This directory is a storage for project data files and service caches.
Inside you will find:

- `cache`: Twig's cache directory
* `cache`: Twig's cache directory

> AVOID storing sensitive data on VCS.
Expand All @@ -62,20 +62,20 @@ When you access the application from the browser, (if not already created) a new

This directory contains all publicly available assets and serves as the entry point of the application:

- `css`: contains `app.css`, a single file containing the entire CSS code collected from all modules, in a minified form
- `fonts`: contains `app`, a directory containing custom font files collected from all modules
- `images`: contains `app`, a directory containing all image files collected from all modules
- `js`: contains `app.js`, a single file containing the entire JavaScript code collected from all modules, in a minified form
- `.htacess`: server configuration file used by Apache web server - this file enables the URL rewrite functionality
- `index.php`: the application's main entry point
- `robots.txt.dist`: a sample robots.txt file, providing settings allow/deny bot access to certain areas of your application - activate it by duplicating the file as `robots.txt` and comment out the lines that don't match your environment
* `css`: contains `app.css`, a single file containing the entire CSS code collected from all modules, in a minified form
* `fonts`: contains `app`, a directory containing custom font files collected from all modules
* `images`: contains `app`, a directory containing all image files collected from all modules
* `js`: contains `app.js`, a single file containing the entire JavaScript code collected from all modules, in a minified form
* `.htacess`: server configuration file used by Apache web server - this file enables the URL rewrite functionality
* `index.php`: the application's main entry point
* `robots.txt.dist`: a sample robots.txt file, providing settings allow/deny bot access to certain areas of your application - activate it by duplicating the file as `robots.txt` and comment out the lines that don't match your environment

### `src` directory

This directory contains two directories, called modules:

- `App`
- `Page`
* `App`
* `Page`

#### `App` directory

Expand All @@ -95,9 +95,9 @@ It contains page-related components for your application.

The `src` directory contains the following items:

- `Controller`: contains module controllers
- `Factory`: contains module factories, which are used to provide ready-to-use instances of certain classes
- `Service`: contains module service files, which contain classes that provide custom functionalities
* `Controller`: contains module controllers
* `Factory`: contains module factories, which are used to provide ready-to-use instances of certain classes
* `Service`: contains module service files, which contain classes that provide custom functionalities
* `ConfigProvider.php` - provides module configuration data
* `RoutesDelegator.php` - stored main routes found in the module

Expand Down

0 comments on commit efae230

Please sign in to comment.