Skip to content

Commit

Permalink
docs(README): improved sections with tips and notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Alcides Ramos committed Jun 3, 2024
1 parent 9de9b97 commit 2df1d75
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ To use this repository you need:
| Miscelaneous | [Bash](https://www.gnu.org/software/bash/) | Allows to create an interactive shell within main service |
| Miscelaneous | [Make](https://www.gnu.org/software/make/) | Allows to execute commands defined on a _Makefile_ |



## Getting Started

Just clone the repository into your preferred path:
Expand All @@ -63,7 +61,8 @@ A custom health check shell script is provided to check the container service vi

This shell script returns a SIGINT if the PHP-FPM service can handle a valid request to FPM `ping` status endpoint.


> [!NOTE]
>
> This health check directive is defined at `Dockerfile` instead of `docker-compose.yml`

Expand Down Expand Up @@ -152,29 +151,32 @@ If you are developing web applications (which requires a web server) this reposi

The default website domain is `https://website.localhost`


> [!IMPORTANT]
>
> Any `.localhost` TLD resolves by default to `127.0.0.1` so no any additional action is required on your *host*.

> [!TIP]
>
> If you want to customize the default website domain please update the files `build/Caddyfile` and `Makefile` accordingly.

###### Certificate Authority (CA) & SSL Certificate

If you experiment any SSL certificate issue on your *host*, please register the **Caddy Authority Certificate** on your browser.


> [!TIP]
>
> A _Makefile_ command is provided called `make install-caddy-certificate` which guides you on this whole process.

>
> This is a one-time action due the certificate does not change after rebuilding/restarting the service.

##### PHP Application

PHP application must be placed into `src` folder.


> [!TIP]
>
> If you are starting a new application from scratch, please consider using [PHP Skeleton](https://github.com/fonil/php-skeleton)

Expand All @@ -184,7 +186,8 @@ PHP application must be placed into `src` folder.

Testing with date and/or time variations sometimes can be a nightmare. To assist on this topic the **UOPZ** extension has been installed and enabled in the container.


> [!TIP]
>
> You should add [slope-it/clock-mock](https://github.com/slope-it/clock-mock) as a development dependency into your `src/composer.json`. This library provides a way for mocking the current timestamp used by PHP for `\DateTime(Immutable)` objects and date/time related functions.

Expand Down

0 comments on commit 2df1d75

Please sign in to comment.