web api v1

Author: victortavaresdev

.dockerignore

@@ -0,0 +1,9 @@
+/.git*
+/.idea*
+.dockerignore
+.editorconfig
+vendor/
+node_modules
+.phpstorm.meta.php
+Dockerfile
+docker-compose.yaml

.editorconfig

@@ -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}]
+indent_size = 2
+
+[docker-compose.yaml]
+indent_size = 2

.env.ci

@@ -0,0 +1,59 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost:8000
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=sqlite
+DB_HOST=
+DB_PORT=
+DB_DATABASE=
+DB_USERNAME=
+DB_PASSWORD=
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailpit
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="hello@example.com"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
+PUSHER_APP_CLUSTER=mt1
+
+VITE_APP_NAME="${APP_NAME}"
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.env.example

@@ -0,0 +1,61 @@
+APP_NAME=Laravel
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=true
+APP_URL=http://localhost:8000
+
+LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
+LOG_LEVEL=debug
+
+DB_CONNECTION=mysql
+DB_HOST=db
+DB_PORT=3306
+DB_DATABASE={YOUR_DATABASE}
+DB_USERNAME={YOUR_USERNAME}
+DB_PASSWORD={YOUR_PASSWORD}
+
+BROADCAST_DRIVER=log
+CACHE_DRIVER=file
+FILESYSTEM_DISK=local
+QUEUE_CONNECTION=sync
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
+
+MEMCACHED_HOST=127.0.0.1
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_MAILER=smtp
+MAIL_HOST=mailpit
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_ENCRYPTION=null
+MAIL_FROM_ADDRESS="hello@example.com"
+MAIL_FROM_NAME="${APP_NAME}"
+
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=us-east-1
+AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
+
+PUSHER_APP_ID=
+PUSHER_APP_KEY=
+PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
+PUSHER_APP_CLUSTER=mt1
+
+VITE_APP_NAME="${APP_NAME}"
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+
+SANCTUM_STATEFUL_DOMAINS=http://localhost:3000

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto eol=lf
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
+CHANGELOG.md export-ignore
+.styleci.yml export-ignore

.gitignore

@@ -0,0 +1,21 @@
+/.phpunit.cache
+/node_modules
+/public/build
+/public/hot
+/public/storage
+/storage/*.key
+/vendor
+.env
+.env.backup
+.env.production
+.phpunit.result.cache
+Homestead.json
+Homestead.yaml
+auth.json
+npm-debug.log
+yarn-error.log
+/.fleet
+/.idea
+/.vscode
+.docker
+.scribe

Dockerfile

@@ -0,0 +1,41 @@
+FROM php:8.1-fpm
+
+# set your user name
+ARG user=victor
+ARG uid=1000
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    curl \
+    libpng-dev \
+    libonig-dev \
+    libxml2-dev \
+    zip \
+    unzip
+
+# Clear cache
+RUN apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# Install PHP extensions
+RUN docker-php-ext-install pdo_mysql mbstring exif pcntl bcmath gd sockets 
+
+# Install PHP Xdebug
+RUN pecl install -o -f xdebug \
+    && docker-php-ext-enable xdebug
+
+# Get latest Composer
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+# Create system user to run Composer and Artisan Commands
+RUN useradd -G www-data,root -u $uid -d /home/$user $user
+RUN mkdir -p /home/$user/.composer && \
+    chown -R $user:$user /home/$user
+
+# Copy custom configurations PHP
+COPY docker/php/php.ini /usr/local/etc/php/
+
+# Set working directory
+WORKDIR /var/www
+
+USER $user

app/Console/Commands/ClearCacheCommand.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Console\Commands;
+
+use Illuminate\Console\Command;
+
+class ClearCacheCommand extends Command
+{
+    protected $signature = 'clear:cache';
+
+    protected $description = 'Clear the application cache.';
+
+    public function handle()
+    {
+        $this->call('cache:clear');
+        $this->call('view:clear');
+        $this->call('config:clear');
+        $this->call('route:clear');
+
+        $this->info('Cache has been cleared successfully!');
+
+        return 0;
+    }
+}

app/Console/Commands/CreateUserCommand.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Enums\AchievementType;
+use App\Models\Achievement;
+use App\Models\User;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Validator;
+use Illuminate\Validation\Rule;
+
+class CreateUserCommand extends Command
+{
+    protected $signature = 'users:create';
+
+    protected $description = 'Command to create a user.';
+
+    public function handle()
+    {
+        $user['name'] = $this->ask('Name of the new user');
+        $user['email'] = $this->ask('Email of the new user');
+        $user['password'] = $this->secret('Password of the new user');
+
+        $user['role'] = $this->choice('Role of the new user', ['USER', 'ADMIN'], 0);
+
+        $validator = Validator::make(
+            $user,
+            [
+                'name' => ['required', 'string', 'max:255'],
+                'email' => ['required', 'string', 'email', 'unique:users', 'max:255'],
+                'password' => ['required', 'string', 'min:6', 'max:255'],
+                'role' => ['required', 'string', Rule::in(['USER', 'ADMIN'])],
+            ]
+        );
+
+        if ($validator->fails()) {
+            foreach ($validator->errors()->all() as $error) {
+                $this->error($error);
+            }
+
+            return -1;
+        }
+
+        $createdUser = User::create($user);
+
+        Achievement::create([
+            'achievement_type' => AchievementType::READY_TO_PLAY->value,
+            'unlocked_at' => now(),
+            'user_id' => $createdUser->id,
+        ]);
+
+        $this->info("User '{$user['email']}' created successfully");
+
+        return 0;
+    }
+}

app/Console/Kernel.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Console;
+
+use App\Console\Commands\ClearCacheCommand;
+use Illuminate\Console\Scheduling\Schedule;
+use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
+
+class Kernel extends ConsoleKernel
+{
+    protected $commands = [
+        ClearCacheCommand::class,
+    ];
+
+    protected function schedule(Schedule $schedule): void
+    {
+        $schedule->command('clear:cache')->daily();
+    }
+
+    protected function commands(): void
+    {
+        $this->load(__DIR__.'/Commands');
+
+        require base_path('routes/console.php');
+    }
+}

app/DTO/Achievement/AchievementDTO.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\DTO\Achievement;
+
+use App\Http\Requests\Achievement\AchievementRequest;
+
+class AchievementDTO
+{
+    public function __construct(
+        public readonly string $achievement_type,
+        public readonly string $unlocked_at
+    ) {
+    }
+
+    public static function fromRequest(AchievementRequest $request): self
+    {
+        return new self(
+            achievement_type: $request->validated('achievement_type'),
+            unlocked_at: $request->validated('unlocked_at')
+        );
+    }
+}

app/DTO/Auth/LoginDTO.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\DTO\Auth;
+
+use App\Http\Requests\Auth\LoginRequest;
+
+class LoginDTO
+{
+    public function __construct(
+        public readonly string $email,
+        public readonly string $password
+    ) {
+    }
+
+    public static function fromRequest(LoginRequest $request): self
+    {
+        return new self(
+            email: $request->validated('email'),
+            password: $request->validated('password')
+        );
+    }
+}