Merge pull request #70 from nspalo/development

Development

.github/workflows/build.yml

@@ -0,0 +1,64 @@
+name: CI Build
+
+on:
+  push:
+    branches: [ "master", "development" ]
+  pull_request:
+    branches: [ "master", "development" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Docker Login
+      env:
+        DOCKER_USER: ${{ secrets.DOCKER_USER }}
+        DOCKER_KEY: ${{ secrets.DOCKER_KEY }}
+      run: |
+        docker login -u $DOCKER_USER -p $DOCKER_KEY
+
+    # Script Permissions
+    - name: Setting up Permissions
+      run: |
+        chmod +x -R ./scripts/*.sh
+        mkdir -p ./storage/logs/ ./bootstrap/cache/
+        chmod 777 ./storage/ ./bootstrap/cache -R
+
+    # Docker Images
+    - name: Building the Docker Images
+      run: ./scripts/build.sh
+
+    # Docker Containers
+    - name: Start Docker Containers
+      run: ./scripts/up.sh -d
+
+    # Composer 
+    - name: Run Composer
+      run: |
+        ./scripts/composer.sh install
+        ./scripts/composer.sh dump-autoload
+        ./scripts/composer.sh run post-root-package-install
+        ./scripts/composer.sh run post-create-project-cmd
+
+    # NPM
+    - name: Run NPM
+      run: |
+        ./scripts/run.sh npm install --loglevel=error
+        ./scripts/run.sh npm run development
+
+    # Code Quality Check
+    - name: Run PhpStan
+      run: ./scripts/composer.sh run phpstan
+
+    - name: Run Easy Coding Sandards
+      run: ./scripts/composer.sh run ecs-all
+
+    - name: Run Automated Test with PhpUnit
+      run: ./scripts/composer.sh run phpunit
+
+    # Teardown
+    - name: Stop container and remove images
+      run: ./scripts/down.sh -v

README.md

@@ -2,6 +2,8 @@
 > This is a simple project that aims to build a template for a 
 > *Dockerize web development environment with NginX, MySQL, PHP, and Laravel*.
 
+![CI BUILD](https://github.com/nspalo/docker-laravel-template/actions/workflows/build.yml/badge.svg)
+
 ## Web Stack
 **Docker containers**
 - nginx

docker/docker-compose.yml

@@ -94,7 +94,7 @@ services:
     networks:
       - web-app
     container_name: npm
-    image: node:16-alpine
+    image: node:20.6-alpine
     working_dir: /var/www/html
     volumes:
       - "${PATH_PROJECT_SOURCE}:/var/www/html"

src/app/Console/Kernel.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Console;
 
 use Illuminate\Console\Scheduling\Schedule;
@@ -25,7 +27,7 @@ protected function schedule(Schedule $schedule)
      */
     protected function commands()
     {
-        $this->load(__DIR__.'/Commands');
+        $this->load(__DIR__ . '/Commands');
 
         require base_path('routes/console.php');
     }

src/app/Exceptions/Handler.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Exceptions;
 
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

src/app/Http/Controllers/Controller.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Controllers;
 
 use Illuminate\Foundation\Auth\Access\AuthorizesRequests;

src/app/Http/Kernel.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http;
 
 use Illuminate\Foundation\Http\Kernel as HttpKernel;

src/app/Http/Middleware/Authenticate.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Auth\Middleware\Authenticate as Middleware;
@@ -12,10 +14,12 @@ class Authenticate extends Middleware
      * @param  \Illuminate\Http\Request  $request
      * @return string|null
      */
-    protected function redirectTo($request)
+    protected function redirectTo($request): ?string
     {
         if (! $request->expectsJson()) {
             return route('login');
         }
+
+        return null;
     }
 }

src/app/Http/Middleware/EncryptCookies.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;

src/app/Http/Middleware/PreventRequestsDuringMaintenance.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Foundation\Http\Middleware\PreventRequestsDuringMaintenance as Middleware;

src/app/Http/Middleware/RedirectIfAuthenticated.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use App\Providers\RouteServiceProvider;
@@ -12,10 +14,10 @@ class RedirectIfAuthenticated
     /**
      * Handle an incoming request.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure(\Illuminate\Http\Request): (\Illuminate\Http\Response|\Illuminate\Http\RedirectResponse)  $next
-     * @param  string|null  ...$guards
-     * @return \Illuminate\Http\Response|\Illuminate\Http\RedirectResponse
+     * @param Request $request
+     * @param Closure $next
+     * @param ...$guards
+     * @return \Illuminate\Contracts\Foundation\Application|\Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector|mixed
      */
     public function handle(Request $request, Closure $next, ...$guards)
     {

src/app/Http/Middleware/TrimStrings.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware;

src/app/Http/Middleware/TrustHosts.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Http\Middleware\TrustHosts as Middleware;

src/app/Http/Middleware/TrustProxies.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Http\Middleware\TrustProxies as Middleware;

src/app/Http/Middleware/VerifyCsrfToken.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Http\Middleware;
 
 use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

src/app/Models/User.php

@@ -1,8 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Models;
 
-use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;

src/app/Providers/AppServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Support\ServiceProvider;

src/app/Providers/AuthServiceProvider.php

@@ -1,9 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
-use Illuminate\Support\Facades\Gate;
 
 class AuthServiceProvider extends ServiceProvider
 {

src/app/Providers/BroadcastServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Support\Facades\Broadcast;

src/app/Providers/EventServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Auth\Events\Registered;

src/app/Providers/RouteServiceProvider.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace App\Providers;
 
 use Illuminate\Cache\RateLimiting\Limit;
@@ -26,14 +28,12 @@ class RouteServiceProvider extends ServiceProvider
      *
      * @var string|null
      */
-    // protected $namespace = 'App\\Http\\Controllers';
+    protected $namespace = ''; // 'App\\Http\\Controllers';
 
     /**
      * Define your route model bindings, pattern filters, etc.
-     *
-     * @return void
      */
-    public function boot()
+    public function boot(): void
     {
         $this->configureRateLimiting();
 

src/composer.json

@@ -18,7 +18,9 @@
         "laravel/sail": "^1.0.1",
         "mockery/mockery": "^1.4.4",
         "nunomaduro/collision": "^5.10",
-        "phpunit/phpunit": "^9.5.10"
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^9.5.10",
+        "symplify/easy-coding-standard": "^12.0"
     },
     "autoload": {
         "psr-4": {
@@ -45,6 +47,27 @@
         ],
         "post-create-project-cmd": [
             "@php artisan key:generate --ansi"
+        ],
+        "phpunit": [
+            "vendor/bin/phpunit --configuration phpunit.xml --coverage-text"
+        ],
+        "phpstan": [
+            "vendor/bin/phpstan --configuration=./phpstan.neon"
+        ],
+        "ecs-all": [
+            "vendor/bin/ecs check app tests --clear-cache"
+        ],
+        "ecs-app": [
+            "vendor/bin/ecs check app --clear-cache"
+        ],
+        "ecs-test": [
+            "vendor/bin/ecs check tests --clear-cache"
+        ],
+        "ecs-app-fix": [
+            "vendor/bin/ecs check app --fix --clear-cache"
+        ],
+        "ecs-test-fix": [
+            "vendor/bin/ecs check tests --fix --clear-cache"
         ]
     },
     "extra": {