Add examples and add api/users route

crynobone · crynobone · commit f5414ae709db · 2025-11-06T15:41:51.000+08:00
Signed-off-by: Mior Muhammad Zaki &lt;crynobone@gmail.com&gt;
diff --git a/app/Enums/TeamRole.php b/app/Enums/TeamRole.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Enums;
+
+enum TeamRole: string
+{
+    case OWNER = 'owner';
+    case ADMIN = 'admin';
+    case MEMBER = 'member';
+}
diff --git a/app/Http/Resources/PostResource.php b/app/Http/Resources/PostResource.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Resources\JsonApi\JsonApiResource;
+
+class PostResource extends JsonApiResource
+{
+    /**
+     * The resource's attributes.
+     *
+     * @var list<string>
+     */
+    protected array $attributes = [
+        'title',
+        'content',
+    ];
+}
diff --git a/app/Http/Resources/UserResource.php b/app/Http/Resources/UserResource.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace App\Http\Resources;
+
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\JsonApi\JsonApiResource;
+
+class UserResource extends JsonApiResource
+{
+    public function toRelationships(Request $request)
+    {
+        return [
+            'posts',
+            'profile',
+            'teams',
+        ];
+    }
+
+    /**
+     * Transform the resource into an array.
+     *
+     * @return array<string, mixed>
+     */
+    public function toAttributes(Request $request): array
+    {
+        return [
+            'name' => $this->name,
+            'email' => $this->email,
+            'verified_at' => fn () => $this->email_verified_at,
+            'avatar' => function () {
+                if ($this->avatar_path) {
+                    return url("storage/{$this->avatar_path}");
+                }
+
+                return null;
+            },
+        ];
+    }
+}
diff --git a/app/Models/Membership.php b/app/Models/Membership.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Models;
+
+use App\Enums\TeamRole;
+use Illuminate\Database\Eloquent\Relations\Pivot;
+
+class Membership extends Pivot
+{
+    /**
+     * The table associated with the model.
+     *
+     * @var string
+     */
+    protected $table = 'team_user';
+
+
+    /**
+     * Get the attributes that should be cast.
+     *
+     * @return array<string, string>
+     */
+    protected function casts(): array
+    {
+        return [
+            'role' => TeamRole::class,
+        ];
+    }
+}
diff --git a/app/Models/Post.php b/app/Models/Post.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    /** @use HasFactory<\Database\Factories\PostFactory> */
+    use HasFactory;
+}
diff --git a/app/Models/Team.php b/app/Models/Team.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+
+class Team extends Model
+{
+    /** @use HasFactory<\Database\Factories\TeamFactory> */
+    use HasFactory;
+
+    /**
+     * Get the attributes that should be cast.
+     *
+     * @return array<string, string>
+     */
+    protected function casts(): array
+    {
+        return [
+            'personal_team' => 'boolean',
+        ];
+    }
+
+    /**
+     * The users that belong to the team.
+     */
+    public function users(): BelongsToMany
+    {
+        return $this->belongsToMany(User::class)
+            ->withPivot('role')
+            ->withTimestamps()
+            ->using(Membership::class)
+            ->as('membership');
+    }
+}
diff --git a/app/Models/User.php b/app/Models/User.php
@@ -2,8 +2,9 @@
 
 namespace App\Models;
 
-// use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
 use Laravel\Fortify\TwoFactorAuthenticatable;
@@ -51,4 +52,24 @@ protected function casts(): array
             'two_factor_confirmed_at' => 'datetime',
         ];
     }
+
+    /**
+     * The profile associated with the user.
+     */
+    public function profile(): HasOne
+    {
+        return $this->hasOne(UserProfile::class);
+    }
+
+    /**
+     * The teams that the user belongs to.
+     */
+    public function teams(): BelongsToMany
+    {
+        return $this->belongsToMany(Team::class)
+            ->withPivot('role')
+            ->withTimestamps()
+            ->using(Membership::class)
+            ->as('membership');
+    }
 }
diff --git a/app/Models/UserProfile.php b/app/Models/UserProfile.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+class UserProfile extends Model
+{
+    /** @use HasFactory<\Database\Factories\UserProfileFactory> */
+    use HasFactory;
+
+    /**
+     * The table associated with the model.
+     *
+     * @var string
+     */
+    protected $table = 'user_profiles';
+
+    /**
+     * The user that owns the profile.
+     */
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class);
+    }
+}
diff --git a/bootstrap/app.php b/bootstrap/app.php
@@ -9,6 +9,7 @@
 
 return Application::configure(basePath: dirname(__DIR__))
     ->withRouting(
+        api: __DIR__.'/../routes/api.php',
         web: __DIR__.'/../routes/web.php',
         commands: __DIR__.'/../routes/console.php',
         health: '/up',
diff --git a/composer.lock b/composer.lock
diff --git a/database/factories/PostFactory.php b/database/factories/PostFactory.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Post>
+ */
+class PostFactory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'user_id' => UserFactory::new(),
+            'title' => $this->faker->word(),
+            'content' => $this->faker->words(10, true),
+        ];
+    }
+}
diff --git a/database/factories/TeamFactory.php b/database/factories/TeamFactory.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Team>
+ */
+class TeamFactory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'name' => $this->faker->unique()->company(),
+            'user_id' => UserFactory::new(),
+            'personal_team' => true,
+        ];
+    }
+}
diff --git a/database/factories/UserProfileFactory.php b/database/factories/UserProfileFactory.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\UserProfile>
+ */
+class UserProfileFactory extends Factory
+{
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition(): array
+    {
+        return [
+            'user_id' => UserFactory::new(),
+        ];
+    }
+}
diff --git a/database/migrations/0001_01_01_000000_create_users_table.php b/database/migrations/0001_01_01_000000_create_users_table.php
@@ -17,6 +17,7 @@ public function up(): void
             $table->string('email')->unique();
             $table->timestamp('email_verified_at')->nullable();
             $table->string('password');
+            $table->string('avatar_path')->nullable();
             $table->rememberToken();
             $table->timestamps();
         });
diff --git a/database/migrations/2025_11_06_065005_create_teams_table.php b/database/migrations/2025_11_06_065005_create_teams_table.php
@@ -0,0 +1,30 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('teams', function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('user_id')->index();
+            $table->string('name');
+            $table->boolean('personal_team');
+            $table->timestamps();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('teams');
+    }
+};
diff --git a/database/migrations/2025_11_06_065138_create_team_user_table.php b/database/migrations/2025_11_06_065138_create_team_user_table.php
@@ -0,0 +1,32 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::create('team_user', function (Blueprint $table) {
+            $table->id();
+            $table->foreignId('team_id');
+            $table->foreignId('user_id');
+            $table->string('role')->nullable();
+            $table->timestamps();
+
+            $table->index(['team_id', 'user_id']);
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::dropIfExists('team_user');
+    }
+};
diff --git a/database/migrations/2025_11_06_071301_create_user_profiles_table.php b/database/migrations/2025_11_06_071301_create_user_profiles_table.php
diff --git a/database/migrations/2025_11_06_072123_create_posts_table.php b/database/migrations/2025_11_06_072123_create_posts_table.php
diff --git a/database/seeders/DatabaseSeeder.php b/database/seeders/DatabaseSeeder.php
diff --git a/routes/api.php b/routes/api.php
