Skip to content
This repository was archived by the owner on Oct 24, 2025. It is now read-only.

feat: onboarding tutorial #5

Merged
me-marcel merged 2 commits into from
Jul 26, 2025
Merged

feat: onboarding tutorial #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
451b635
feat: onboarding tutorial
me-marcel Jul 26, 2025
ae4f198
chore: add guide background
me-marcel Jul 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions app/Http/Controllers/ProjectController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ public function page_index(Request $request)
return view('project.index', [
'projects' => Project::paginate(10),
'statistics' => Project::allStatistics(),
...(!$request->project_id ? [
'onboarding_status' => $request->get('onboarding_status'),
'onboarding_dismissed' => !empty(Auth::user()->onboarding_dismissed_at),
] : []),
]);
}

Expand Down
15 changes: 15 additions & 0 deletions app/Http/Controllers/UserController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

use App\Helpers\PermissionSet;
use App\Models\User;
use Carbon\Carbon;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Auth;
Expand Down Expand Up @@ -161,4 +162,18 @@ public function action_delete(string $user_id)

return redirect()->back()->with('warning', 'Ooops, something went wrong.');
}

/**
* Dismiss the onboarding.
*
* @return \Illuminate\Http\RedirectResponse
*/
public function action_dismiss_onboarding()
{
Auth::user()->update([
'onboarding_dismissed_at' => Carbon::now(),
]);

return redirect()->route('project.index')->with('success', 'Onboarding dismissed successfully.');
}
}
51 changes: 51 additions & 0 deletions app/Http/Middleware/IdentifyOnboardingStatus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?php

declare(strict_types=1);

namespace App\Http\Middleware;

use App\Models\Kubernetes\Clusters\Cluster;
use App\Models\Projects\Deployments\Deployment;
use App\Models\Projects\Projects\Project;
use App\Models\Projects\Templates\Template;
use Closure;
use Illuminate\Http\Request;

/**
* Class IdentifyOnboardingStatus.
*
* This class is the middleware for identifying the onboarding status.
*
* @author Marcel Menk <marcel.menk@ipvx.io>
*/
class IdentifyOnboardingStatus
{
/**
* Handle an incoming request.
*
* @param Request $request
* @param Closure $next
*
* @return mixed
*/
public function handle(Request $request, Closure $next)
{
$firstProject = Project::first();
$hasProjects = !empty($firstProject);
$hasClusterProvisionerTemplates = Template::where('type', '=', 'cluster')->count() > 0;
$hasClusters = Cluster::query()->count() > 0;
$hasApplicationTemplates = Template::where('type', '=', 'application')->count() > 0;
$hasApplications = Deployment::query()->count() > 0;

$request->attributes->add(['onboarding_status' => (object) [
'projects' => $hasProjects,
'cluster_provisioner_templates' => $hasClusterProvisionerTemplates,
'clusters' => $hasClusters,
'application_templates' => $hasApplicationTemplates,
'applications' => $hasApplications,
'first_project' => $firstProject,
]]);

return $next($request);
}
}
9 changes: 6 additions & 3 deletions app/Models/User.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
* @OA\Property(property="email_verified_at", type="string", format="date-time", example="2021-01-01T00:00:00Z", nullable=true),
* @OA\Property(property="password", type="string", example="password123"),
* @OA\Property(property="remember_token", type="string", example="remember_token123", nullable=true),
* @OA\Property(property="onboarding_dismissed_at", type="string", format="date-time", example="2021-01-01 00:00:00", nullable=true),
* @OA\Property(property="created_at", type="string", format="date-time", example="2021-01-01 00:00:00", nullable=true),
* @OA\Property(property="updated_at", type="string", format="date-time", example="2021-01-01 00:00:00", nullable=true),
* )
Expand All @@ -51,7 +52,7 @@
* @property string $email
* @property string $password
* @property string $remember_token
* @property string $email_verified_at
* @property string $onboarding_dismissed_at
* @property string $created_at
* @property string $updated_at
*
Expand Down Expand Up @@ -85,6 +86,7 @@ class User extends Authenticatable implements JWTSubject
'name',
'email',
'password',
'onboarding_dismissed_at',
];

/**
Expand All @@ -105,8 +107,9 @@ class User extends Authenticatable implements JWTSubject
protected function casts(): array
{
return [
'email_verified_at' => 'datetime',
'password' => 'hashed',
'email_verified_at' => 'datetime',
'password' => 'hashed',
'onboarding_dismissed_at' => 'datetime',
];
}

Expand Down
29 changes: 29 additions & 0 deletions database/migrations/2025_07_26_000001_update_user_tables.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

declare(strict_types=1);

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()
{
Schema::table('users', function (Blueprint $table) {
$table->timestamp('onboarding_dismissed_at')->nullable()->after('remember_token');
});
}

/**
* Reverse the migrations.
*/
public function down()
{
Schema::table('users', function (Blueprint $table) {
$table->dropColumn('onboarding_dismissed_at');
});
}
};
12 changes: 12 additions & 0 deletions resources/images/path.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions resources/sass/app.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,3 +553,48 @@ main {
font-weight: 600;
color: var(--bs-white);
}

.indicator-success {
position: absolute;
top: 0;
right: -0.5rem;
width: 1rem;
height: 1rem;
border-radius: 50%;
background-color: var(--bs-success);
}

.indicator-warning {
position: absolute;
top: 0;
right: -0.5rem;
width: 1rem;
height: 1rem;
border-radius: 50%;
background-color: var(--bs-warning);
}

.get-started {
> .card-body {
position: relative;

&:after {
content: '';
position: absolute;
bottom: 0;
right: 0;
width: 100%;
height: 100%;
background: url('../images/path.svg') no-repeat right center;
background-size: contain;
z-index: 1;
opacity: 0.25;
transform: scale(1.25);
}

> * {
position: relative;
z-index: 2;
}
}
}
123 changes: 123 additions & 0 deletions resources/views/project/index.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,129 @@
<div class="row justify-content-center">
<div class="col-md-12">
@if (empty(request()->get('project')))
@if (!$onboarding_dismissed)
<div class="card mb-3 border border-secondary get-started">
<div class="card-header d-flex justify-content-between align-items-center">
{{ __('Getting started') }}
<a href="{{ route('onboarding.dismiss') }}" class="text-white" title="{{ __('Dismiss') }}">
<i class="bi bi-x"></i>
</a>
</div>
<div class="card-body text-center p-5">
<div class="row d-flex justify-content-center row-gap-4">
<div class="col-md-4">
<div class="card mb-3 border h-100">
<div class="card-body d-flex flex-column justify-content-between">
<div>
<i class="bi bi-folder-plus fs-1 text-secondary position-relative">
@if ($onboarding_status->projects)
<span class="indicator-success"></span>
@else
<span class="indicator-warning"></span>
@endif
</i>
<h5 class="card-title">{{ __('Create a project') }}</h5>
</div>
@if (!$onboarding_status->projects)
<a href="{{ route('project.add') }}" class="btn btn-sm btn-primary mt-2">{{ __('Create') }}</a>
@else
<a href="#" class="btn btn-sm btn-secondary mt-2 disabled">{{ __('Done') }}</a>
@endif
</div>
</div>
</div>
<div class="col-md-4">
<div class="card mb-3 border h-100">
<div class="card-body d-flex flex-column justify-content-between">
<div>
<i class="bi bi-file-earmark-plus fs-1 text-secondary position-relative">
@if ($onboarding_status->cluster_provisioner_templates)
<span class="indicator-success"></span>
@else
<span class="indicator-warning"></span>
@endif
</i>
<h5 class="card-title">{{ __('Create a cluster provisioner template') }}</h5>
</div>
@if (!$onboarding_status->cluster_provisioner_templates)
<a href="{{ route('template.add', ['type' => 'cluster']) }}" class="btn btn-sm btn-primary mt-2">{{ __('Create') }}</a>
@else
<a href="#" class="btn btn-sm btn-secondary mt-2 disabled">{{ __('Done') }}</a>
@endif
</div>
</div>
</div>
<div class="col-md-4">
<div class="card mb-3 border h-100">
<div class="card-body d-flex flex-column justify-content-between">
<div>
<i class="bi bi-hdd-stack fs-1 text-secondary position-relative">
@if ($onboarding_status->clusters)
<span class="indicator-success"></span>
@else
<span class="indicator-warning"></span>
@endif
</i>
<h5 class="card-title">{{ __('Create a cluster') }}</h5>
</div>
@if (empty($onboarding_status->first_project))
<a href="{{ route('project.add') }}" class="btn btn-sm btn-primary mt-2">{{ __('Create a project') }}</a>
@elseif (!$onboarding_status->clusters)
<a href="{{ route('cluster.add', ['project_id' => $onboarding_status->first_project->id]) }}" class="btn btn-sm btn-primary mt-2">{{ __('Create') }}</a>
@else
<a href="#" class="btn btn-sm btn-secondary mt-2 disabled">{{ __('Done') }}</a>
@endif
</div>
</div>
</div>
<div class="col-md-4">
<div class="card mb-3 border h-100">
<div class="card-body d-flex flex-column justify-content-between">
<div>
<i class="bi bi-file-earmark-plus fs-1 text-secondary position-relative">
@if ($onboarding_status->application_templates)
<span class="indicator-success"></span>
@else
<span class="indicator-warning"></span>
@endif
</i>
<h5 class="card-title">{{ __('Create an application template') }}</h5>
</div>
@if (!$onboarding_status->application_templates)
<a href="{{ route('template.add', ['type' => 'application']) }}" class="btn btn-sm btn-primary mt-2">{{ __('Create') }}</a>
@else
<a href="#" class="btn btn-sm btn-secondary mt-2 disabled">{{ __('Done') }}</a>
@endif
</div>
</div>
</div>
<div class="col-md-4">
<div class="card mb-3 border h-100">
<div class="card-body d-flex flex-column justify-content-between">
<div>
<i class="bi bi-box fs-1 text-secondary position-relative">
@if ($onboarding_status->applications)
<span class="indicator-success"></span>
@else
<span class="indicator-warning"></span>
@endif
</i>
<h5 class="card-title">{{ __('Create an application') }}</h5>
</div>
@if (empty($onboarding_status->first_project))
<a href="{{ route('project.add') }}" class="btn btn-sm btn-primary mt-2">{{ __('Create a project') }}</a>
@elseif (!$onboarding_status->applications)
<a href="{{ route('deployment.add', ['project_id' => $onboarding_status->first_project->id]) }}" class="btn btn-sm btn-primary mt-2">{{ __('Create') }}</a>
@else
<a href="#" class="btn btn-sm btn-secondary mt-2 disabled">{{ __('Done') }}</a>
@endif
</div>
</div>
</div>
</div>
</div>
</div>
@endif
<div class="card mb-3 border border-secondary">
<div class="card-header d-flex justify-content-between align-items-center">
{{ __('Infrastructure') }}
Expand Down
5 changes: 5 additions & 0 deletions routes/web.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
declare(strict_types=1);

use App\Http\Middleware\CheckVersion;
use App\Http\Middleware\IdentifyOnboardingStatus;
use App\Http\Middleware\IdentifyProject;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;

Route::get('/', function () {
Expand All @@ -24,7 +26,10 @@
'auth',
IdentifyProject::class,
CheckVersion::class,
IdentifyOnboardingStatus::class,
])->group(function () {
Route::get('/onboarding/dismiss', [App\Http\Controllers\UserController::class, 'action_dismiss_onboarding'])->name('onboarding.dismiss');

Route::get('/activities', [App\Http\Controllers\ActivityController::class, 'page_index'])->name('activity.index')->middleware('ui.permission.guard:activities.view');

Route::get('/projects', [App\Http\Controllers\ProjectController::class, 'page_index'])->name('project.index')->middleware('ui.permission.guard:projects.view');
Expand Down
8 changes: 5 additions & 3 deletions tests/Unit/Models/UserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public function itHasCorrectFillableAttributes(): void
'name',
'email',
'password',
'onboarding_dismissed_at',
];

$this->assertEquals($fillable, $this->user->getFillable());
Expand All @@ -82,9 +83,10 @@ public function itHasCorrectHiddenAttributes(): void
public function itHasCorrectCasts(): void
{
$casts = [
'email_verified_at' => 'datetime',
'password' => 'hashed',
'id' => 'int',
'email_verified_at' => 'datetime',
'password' => 'hashed',
'onboarding_dismissed_at' => 'datetime',
'id' => 'int',
];

$this->assertEquals($casts, $this->user->getCasts());
Expand Down