diff --git a/.github/linters/.gitleaks.toml b/.github/linters/.gitleaks.toml new file mode 100644 index 0000000..661656a --- /dev/null +++ b/.github/linters/.gitleaks.toml @@ -0,0 +1,7 @@ +title = "gitleaks config" + +[allowlist] +description = "Allowlisted files" +paths = [ + '''web/ssl/.*''', +] diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c9c2b6..40d794c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,12 @@ ## 0.1.2 October 8, 2025 +- Bug #194: Use stable version for `yii2-extensions/franken-php:^0.1` in `composer.json` (@terabytesoftw) +- Bug #195: Update package badge in `README.md` to reflect latest stable version (@terabytesoftw) - Bug #197: Update workflows and documentation for improved CI/CD processes and feature clarity (@terabytesoftw) - Bug #198: Add `Super-Linter` badge to `README.md` for enhanced CI visibility (@terabytesoftw) - Bug #199: Correct indentation in console configuration section of `README.md` (@terabytesoftw) +- Bug #200: Add Gitleaks configuration and update documentation for improved clarity and consistency (@terabytesoftw) ## 0.1.1 September 03, 2025 @@ -15,7 +18,7 @@ - Bug #150: Add container configuration to `console` app setup (@terabytesoftw) - Enh #151: Implement `FrankenPHP` stack (@terabytesoftw) - Bug #152: Remove redundant `Quick start` section header from `README.md` (@terabytesoftw) -- Bug #154: Update links and headings in `README.md` for clarity and consistency (@terabytesoftw) +- Bug #154: Update links and headings in `README.md` for clarity and consistency (@terabytesoftw) - Bug #156: Update `README.md` with new Packagist badges and improve structure (@terabytesoftw) - Bug #159: Remove redundant `Basic usage` section from `README.md` (@terabytesoftw) - Bug #162: Update `README.md` to reorganize `Package information` and add latest stable version badge (@terabytesoftw) diff --git a/README.md b/README.md index 0b8391b..379da9e 100644 --- a/README.md +++ b/README.md @@ -11,20 +11,11 @@

- - PHP version - - - Yii 2.0.x - - - Yii 22.0.x - - Codeception + Codeception - PHPStan + PHPStan

@@ -41,18 +32,14 @@ ## Features -- ✅ **Asset Management** - Optimized asset bundles for CSS, JS, and resource management. -- ✅ **Clean Architecture** - Well-organized directory structure following Yii2 best practices. -- ✅ **Console Commands** - Example console commands for background tasks and maintenance. -- ✅ **Developer Tools** - Debugging tools, logging, and development-friendly configurations. -- ✅ **HTTP/2 & HTTP/3 Support**: Native support for modern HTTP protocols with multiplexing. -- ✅ **HTTPS/TLS Support** - Secure your application with built-in HTTPS support. -- ✅ **Modern Bootstrap 5 UI** - Responsive, mobile-first design with latest Bootstrap components. -- ✅ **Testing Ready** - Codeception test suite with examples for functional and unit testing. + + + Feature Overview + ## How it works -The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting +The Yii2 Web Application Basic template provides a complete foundation for building modern web applications. Unlike starting from scratch, this template includes. 1. **Pre-configured structure** with organized directories for assets, views, models, and controllers. @@ -94,6 +81,9 @@ Start the server in CLI mode Download and start the server with [Docker images](https://frankenphp.dev/docs/docker/) Gitbash/Windows + + + ```bash docker run \ -e CADDY_GLOBAL_OPTIONS="auto_https off" \ @@ -107,11 +97,16 @@ docker run \ --name yii2-frankenphp-worker \ dunglas/frankenphp ``` + + > **Note:** Paths in the example (`//k/yii2-extensions/app-basic`) are for demonstration purposes only. > Replace them with the actual path to your Yii2 project on your system. Linux/WSL + + + ```bash docker run \ -e CADDY_GLOBAL_OPTIONS="auto_https off" \ @@ -125,7 +120,10 @@ docker run \ --name yii2-frankenphp-worker \ dunglas/frankenphp ``` + + +> [!IMPORTANT] > Your application will be available at `https://localhost:8443` or at the address set in the `Caddyfile`. #### Directory structure @@ -185,12 +183,16 @@ final class SiteController extends Controller ## Package information +[![PHP](https://img.shields.io/badge/%3E%3D8.1-777BB4.svg?style=for-the-badge&logo=php&logoColor=white)](https://www.php.net/releases/8.1/en.php) +[![Yii 2.0.x](https://img.shields.io/badge/2.0.53-0073AA.svg?style=for-the-badge&logo=yii&logoColor=white)](https://github.com/yiisoft/yii2/tree/2.0.53) +[![Yii 22.0.x](https://img.shields.io/badge/22.0.x-0073AA.svg?style=for-the-badge&logo=yii&logoColor=white)](https://github.com/yiisoft/yii2/tree/22.0) [![Latest Stable Version](https://img.shields.io/packagist/v/yii2-extensions/franken-php.svg?style=for-the-badge&logo=packagist&logoColor=white&label=Stable)](https://packagist.org/packages/yii2-extensions/franken-php) ## Quality code [![Codecov](https://img.shields.io/codecov/c/github/yii2-extensions/app-basic.svg?branch=main&style=for-the-badge&logo=codecov&logoColor=white&label=Coverage)](https://codecov.io/github/yii2-extensions/app-basic) [![PHPStan Level Max](https://img.shields.io/badge/PHPStan-Level%20Max-4F5D95.svg?style=for-the-badge&logo=php&logoColor=white)](https://github.com/yii2-extensions/app-basic/actions/workflows/static.yml?query=branch%3Afranken-php) +[![Super-Linter](https://img.shields.io/github/actions/workflow/status/yii2-extensions/app-basic/linter.yml?style=for-the-badge&label=Super-Linter&logo=github)](https://github.com/yii2-extensions/app-basic/actions/workflows/linter.yml?query=branch%3Afranken-php) [![StyleCI](https://img.shields.io/badge/StyleCI-Passed-44CC11.svg?style=for-the-badge&logo=styleci&logoColor=white)](https://github.styleci.io/repos/165419144?branch=franken-php) ## Documentation diff --git a/docs/svgs/features-mobile.svg b/docs/svgs/features-mobile.svg index 327abb4..38cb8b4 100644 --- a/docs/svgs/features-mobile.svg +++ b/docs/svgs/features-mobile.svg @@ -1,5 +1,5 @@ - +