Add default API Skeleton projet

Author: mckenziearts

CHANGELOG.md

@@ -0,0 +1 @@
+# Laravel API Skeleton

CODE_OF_CONDUCT.md

@@ -20,8 +20,7 @@
     "laravel/framework": "^10.2",
     "laravel/sanctum": "^3.2.1",
     "laravel/tinker": "^2.8.1",
-    "timacdonald/json-api": "v1.0.0-beta.4",
-    "treblle/treblle-laravel": "^2.8.6"
+    "timacdonald/json-api": "v1.0.0-beta.4"
   },
   "require-dev": {
     "fakerphp/faker": "^1.21.0",
@@ -32,12 +31,15 @@
     "nunomaduro/larastan": "^2.5.1",
     "pestphp/pest": "^1.22.5",
     "pestphp/pest-plugin-laravel": "^1.4",
-    "spatie/laravel-ignition": "^2.0"
+    "spatie/laravel-ignition": "^2.0",
+    "symfony/console": "^6.3",
+    "symfony/filesystem": "^6.3"
   },
   "autoload": {
     "psr-4": {
       "App\\": "app/",
       "Core\\": ".core/",
+      "Skeleton\\": "skeleton/",
       "Database\\Factories\\": "database/factories/",
       "Database\\Seeders\\": "database/seeders/"
     }

LICENSE.md

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Console;
+
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+final class Kernel extends ConsoleKernel
+{
+    protected function schedule(Schedule $schedule): void
+    {
+        //
+    }
+
+    protected function commands(): void
+    {
+        $this->load(
+            paths: [
+                __DIR__ . '/../app/Console/Commands',
+            ],
+        );
+    }
+}

README-example.md

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Exceptions;
+
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Throwable;
+
+final class Handler extends ExceptionHandler
+{
+    protected $levels = [];
+
+    protected $dontReport = [];
+
+    protected $dontFlash = [
+        'current_password',
+        'password',
+        'password_confirmation',
+    ];
+
+    public function register(): void
+    {
+        $this->reportable(function (Throwable $e) {
+            //
+        });
+    }
+}

SECURITY.md

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Http\Controllers;
+
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+use Illuminate\Routing\Controller as BaseController;
+
+abstract class Controller extends BaseController
+{
+    use AuthorizesRequests;
+    use ValidatesRequests;
+}

composer.json

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Http;
+
+use App\Http\Middleware\CacheHeaders;
+use App\Http\Middleware\EnsureEmailIsVerified;
+use App\Http\Middleware\JsonApiResponseMiddleware;
+use App\Http\Middleware\PreventRequestsDuringMaintenance;
+use App\Http\Middleware\TrimStrings;
+use App\Http\Middleware\TrustProxies;
+use App\Http\Middleware\ValidateSignature;
+use Illuminate\Auth\Middleware\Authenticate;
+use Illuminate\Auth\Middleware\Authorize;
+use Illuminate\Auth\Middleware\RequirePassword;
+use Illuminate\Foundation\Http\Kernel as HttpKernel;
+use Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull;
+use Illuminate\Foundation\Http\Middleware\ValidatePostSize;
+use Illuminate\Http\Middleware\HandleCors;
+use Illuminate\Http\Middleware\SetCacheHeaders;
+use Illuminate\Routing\Middleware\ThrottleRequests;
+
+final class Kernel extends HttpKernel
+{
+    protected $middleware = [
+        TrustProxies::class,
+        HandleCors::class,
+        PreventRequestsDuringMaintenance::class,
+        ValidatePostSize::class,
+        TrimStrings::class,
+        ConvertEmptyStringsToNull::class,
+    ];
+
+    protected $middlewareGroups = [
+        'web' => [],
+
+        'api' => [
+            ThrottleRequests::class.':api',
+            JsonApiResponseMiddleware::class,
+            CacheHeaders::class,
+        ],
+    ];
+
+    protected $middlewareAliases = [
+        'auth' => Authenticate::class,
+        'cache.headers' => SetCacheHeaders::class,
+        'can' => Authorize::class,
+        'password.confirm' => RequirePassword::class,
+        'signed' => ValidateSignature::class,
+        'throttle' => ThrottleRequests::class,
+        'verified' => EnsureEmailIsVerified::class,
+    ];
+}

composer.lock

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+final class AppServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        //
+    }
+}

projects/default/.core/Console/Kernel.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Providers;
+
+use Illuminate\Auth\Notifications\ResetPassword;
+use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
+
+final class AuthServiceProvider extends ServiceProvider
+{
+    protected $policies = [];
+
+    public function boot(): void
+    {
+        $this->registerPolicies();
+    }
+}

projects/default/.core/Exceptions/Handler.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Providers;
+
+use Illuminate\Support\Facades\Broadcast;
+use Illuminate\Support\ServiceProvider;
+
+final class BroadcastServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        Broadcast::routes();
+        require base_path('routes/sockets/routes.php');
+    }
+}

projects/default/.core/Http/Controllers/Controller.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Providers;
+
+use Illuminate\Auth\Events\Registered;
+use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+final class EventServiceProvider extends ServiceProvider
+{
+    protected $listen = [
+        Registered::class => [
+            SendEmailVerificationNotification::class,
+        ],
+    ];
+}

projects/default/.core/Http/Kernel.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Core\Providers;
+
+use Illuminate\Cache\RateLimiting\Limit;
+use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\RateLimiter;
+use Illuminate\Support\Facades\Route;
+
+final class RouteServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->configureRateLimiting();
+
+        $this->routes(static function (): void {
+            Route::middleware('api')
+                ->as('api:')
+                ->group(
+                    base_path('routes/api/routes.php')
+                );
+        });
+    }
+
+    protected function configureRateLimiting(): void
+    {
+        RateLimiter::for(
+            name: 'api',
+            callback: static fn (Request $request): Limit => Limit::perMinute(
+                maxAttempts: 60,
+            )->by(
+                key: $request->user()?->id ?: $request->ip(),
+            ),
+        );
+    }
+}

projects/default/.core/Providers/AppServiceProvider.php

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml,json}]
+indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4